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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import pytest
import logging
import pytest
import uuid
import datetime
import functools
import secrets
import base64
from azure.servicebus.management import ServiceBusAdministrationClient, QueueProperties, ApiVersion, AuthorizationRule, AccessRights
from azure.servicebus._common.utils import utc_now
from utilities import get_logger
from azure.core.exceptions import HttpResponseError, ResourceNotFoundError, ResourceExistsError
from azure.servicebus._base_handler import ServiceBusSharedKeyCredential
from devtools_testutils import AzureMgmtRecordedTestCase, CachedResourceGroupPreparer, recorded_by_proxy, get_credential
from sb_env_loader import (
ServiceBusPreparer,
)
from servicebus_preparer import SERVICEBUS_ENDPOINT_SUFFIX
from mgmt_test_utilities import (
MgmtQueueListTestHelper,
MgmtQueueListRuntimeInfoTestHelper,
run_test_mgmt_list_with_parameters,
run_test_mgmt_list_with_negative_parameters,
clear_queues,
clear_topics,
)
_logger = get_logger(logging.DEBUG)
class TestServiceBusAdministrationClientQueue(AzureMgmtRecordedTestCase):
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_basic(
self,
servicebus_connection_str,
servicebus_fully_qualified_namespace,
servicebus_sas_policy,
servicebus_sas_key,
**kwargs,
):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
mgmt_service.create_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 1 and queues[0].name == "test_queue"
mgmt_service.delete_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
# mgmt_service = ServiceBusAdministrationClient(
# servicebus_fully_qualified_namespace,
# credential=ServiceBusSharedKeyCredential(servicebus_sas_policy, servicebus_sas_key)
# )
# queues = list(mgmt_service.list_queues())
# assert len(queues) == 0
# mgmt_service.create_queue("test_queue")
# queues = list(mgmt_service.list_queues())
# assert len(queues) == 1 and queues[0].name == "test_queue"
# mgmt_service.delete_queue("test_queue")
# queues = list(mgmt_service.list_queues())
# assert len(queues) == 0
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_with_special_chars(self, servicebus_fully_qualified_namespace):
# Queue names can contain letters, numbers, periods (.), hyphens (-), underscores (_), and slashes (/), up to 260 characters. Queue names are also case-insensitive.
queue_name = "txt/.-_123"
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
mgmt_service.create_queue(queue_name)
queues = list(mgmt_service.list_queues())
assert len(queues) == 1 and queues[0].name == queue_name
mgmt_service.delete_queue(queue_name)
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_with_parameters(self, servicebus_fully_qualified_namespace):
pytest.skip("start_idx and max_count are currently removed, they might come back in the future.")
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
run_test_mgmt_list_with_parameters(MgmtQueueListTestHelper(mgmt_service))
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_with_negative_credential(
self, servicebus_fully_qualified_namespace, servicebus_sas_policy, servicebus_sas_key
):
# invalid_conn_str = 'Endpoint=sb://invalid.servicebus.windows.net/;SharedAccessKeyName=invalid;SharedAccessKey=invalid'
# mgmt_service = ServiceBusAdministrationClient.from_connection_string(invalid_conn_str)
# with pytest.raises(ServiceRequestError):
# list(mgmt_service.list_queues())
# TODO: This negative test makes replay test fail. Need more investigation. Live test has no problem.
invalid_conn_str = "Endpoint=sb://{}/;SharedAccessKeyName=invalid;SharedAccessKey=invalid".format(
servicebus_fully_qualified_namespace
)
mgmt_service = ServiceBusAdministrationClient.from_connection_string(invalid_conn_str)
with pytest.raises(HttpResponseError):
list(mgmt_service.list_queues())
# fully_qualified_namespace = 'invalid.servicebus.windows.net'
# mgmt_service = ServiceBusAdministrationClient(
# fully_qualified_namespace,
# credential=ServiceBusSharedKeyCredential(servicebus_sas_policy, servicebus_sas_key)
# )
# with pytest.raises(ServiceRequestError):
# list(mgmt_service.list_queues())
mgmt_service = ServiceBusAdministrationClient(
servicebus_fully_qualified_namespace, credential=ServiceBusSharedKeyCredential("invalid", "invalid")
)
with pytest.raises(HttpResponseError):
list(mgmt_service.list_queues())
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_with_negative_parameters(self, servicebus_fully_qualified_namespace):
pytest.skip("start_idx and max_count are currently removed, they might come back in the future.")
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
run_test_mgmt_list_with_negative_parameters(MgmtQueueListTestHelper(mgmt_service))
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_delete_basic(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
mgmt_service.create_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 1
mgmt_service.create_queue("txt/.-_123")
queues = list(mgmt_service.list_queues())
assert len(queues) == 2
mgmt_service.delete_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 1 and queues[0].name == "txt/.-_123"
mgmt_service.delete_queue("txt/.-_123")
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_delete_one_and_check_not_existing(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
for i in range(10):
mgmt_service.create_queue("queue{}".format(i))
delete_idx = 0
to_delete_queue_name = "queue{}".format(delete_idx)
mgmt_service.delete_queue(to_delete_queue_name)
queue_names = [queue.name for queue in list(mgmt_service.list_queues())]
assert len(queue_names) == 9 and to_delete_queue_name not in queue_names
for name in queue_names:
mgmt_service.delete_queue(name)
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_delete_negtive(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
mgmt_service.create_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 1
mgmt_service.delete_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
with pytest.raises(ResourceNotFoundError):
mgmt_service.delete_queue("test_queue")
with pytest.raises(ResourceNotFoundError):
mgmt_service.delete_queue("non_existing_queue")
with pytest.raises(ValueError):
mgmt_service.delete_queue("")
with pytest.raises(TypeError):
mgmt_service.delete_queue(queue_name=None)
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_create_by_name(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "queue_testaddf"
mgmt_service.create_queue(queue_name)
created_at_utc = utc_now()
try:
queue = mgmt_service.get_queue(queue_name)
assert queue.name == queue_name
assert queue.availability_status == "Available"
assert queue.status == "Active"
# assert created_at_utc < queue.created_at_utc < utc_now() + datetime.timedelta(minutes=10)
finally:
mgmt_service.delete_queue(queue_name)
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_create_with_invalid_name(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
with pytest.raises(HttpResponseError):
mgmt_service.create_queue(Exception())
with pytest.raises(HttpResponseError):
mgmt_service.create_queue("")
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_create_with_queue_description(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "iweidk"
queue_name_2 = "vladsk"
queue_name_3 = "famviq"
topic_name = "aghadh"
def generate_random_key():
key256 = secrets.token_bytes(32)
return base64.b64encode(key256).decode('utf-8')
auth_rule = AuthorizationRule(
type="SharedAccessAuthorizationRule",
key_name="test_key",
claim_type="SharedAccessKey",
claim_value="None",
rights=[AccessRights.MANAGE, AccessRights.LISTEN, AccessRights.SEND],
primary_key=generate_random_key(),
secondary_key=generate_random_key(),
)
# TODO: Why don't we have an input model (queueOptions? as superclass of QueueProperties?) and output model to not show these params?
# TODO: This fails with the following: E msrest.exceptions.DeserializationError: Find several XML 'prefix:DeadLetteringOnMessageExpiration' where it was not expected .tox\whl\lib\site-packages\msrest\serialization.py:1262: DeserializationError
mgmt_service.create_topic(topic_name)
mgmt_service.create_queue(
queue_name,
auto_delete_on_idle=datetime.timedelta(minutes=10),
dead_lettering_on_message_expiration=True,
default_message_time_to_live=datetime.timedelta(minutes=11),
duplicate_detection_history_time_window=datetime.timedelta(minutes=12),
enable_batched_operations=True,
enable_express=True,
enable_partitioning=True,
forward_dead_lettered_messages_to=topic_name,
forward_to=topic_name,
lock_duration=datetime.timedelta(seconds=13),
max_delivery_count=14,
max_size_in_megabytes=3072,
# requires_duplicate_detection=True,
requires_session=True,
authorization_rules=[auth_rule],
)
mgmt_service.create_queue(
queue_name_2,
auto_delete_on_idle="PT10M1S",
dead_lettering_on_message_expiration=True,
default_message_time_to_live="PT11M2S",
duplicate_detection_history_time_window="PT12M3S",
enable_batched_operations=True,
enable_express=True,
enable_partitioning=True,
forward_dead_lettered_messages_to=topic_name,
forward_to=topic_name,
lock_duration="PT13S",
max_delivery_count=14,
max_size_in_megabytes=3072,
requires_session=True,
)
with pytest.raises(HttpResponseError):
mgmt_service.create_queue(
queue_name_3, max_message_size_in_kilobytes=1024 # basic/standard ties does not support
)
try:
queue = mgmt_service.get_queue(queue_name)
assert queue.name == queue_name
assert queue.auto_delete_on_idle == datetime.timedelta(minutes=10)
assert queue.dead_lettering_on_message_expiration == True
assert queue.default_message_time_to_live == datetime.timedelta(minutes=11)
assert queue.duplicate_detection_history_time_window == datetime.timedelta(minutes=12)
assert queue.enable_batched_operations == True
assert queue.enable_express == True
assert queue.enable_partitioning == True
# assert queue.forward_dead_lettered_messages_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}")
# assert queue.forward_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}")
assert queue.lock_duration == datetime.timedelta(seconds=13)
assert queue.max_delivery_count == 14
assert (
queue.max_size_in_megabytes % 3072 == 0
) # TODO: In my local test, I don't see a multiple of the input number. To confirm
# This is disabled due to the following error:
# azure.core.exceptions.HttpResponseError: SubCode=40000. Both DelayedPersistence property and RequiresDuplicateDetection property cannot be enabled together.
# To know more visit https://aka.ms/sbResourceMgrExceptions.
# assert queue.requires_duplicate_detection == True
assert queue.requires_session == True
assert queue.authorization_rules[0].key_name == "test_key"
assert len(queue.authorization_rules[0].rights) == 3
queue2 = mgmt_service.get_queue(queue_name_2)
assert queue2.name == queue_name_2
assert queue2.auto_delete_on_idle == datetime.timedelta(minutes=10, seconds=1)
assert queue2.dead_lettering_on_message_expiration == True
assert queue2.default_message_time_to_live == datetime.timedelta(minutes=11, seconds=2)
assert queue2.duplicate_detection_history_time_window == datetime.timedelta(minutes=12, seconds=3)
assert queue2.enable_batched_operations == True
assert queue2.enable_express == True
assert queue2.enable_partitioning == True
assert queue2.forward_dead_lettered_messages_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}")
# assert queue2.forward_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}")
assert queue2.lock_duration == datetime.timedelta(seconds=13)
assert queue2.max_delivery_count == 14
assert queue2.max_size_in_megabytes % 3072 == 0
assert queue2.requires_session == True
finally:
mgmt_service.delete_queue(queue_name)
mgmt_service.delete_queue(queue_name_2)
mgmt_service.delete_topic(topic_name)
mgmt_service.close()
@pytest.mark.skip("Unkip after creating premium account in arm template")
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_premium_create_with_queue_description(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "iweidk"
queue_name_2 = "cpqmva"
queue_name_3 = "rekocd"
mgmt_service.create_queue(
queue_name,
auto_delete_on_idle=datetime.timedelta(minutes=10),
dead_lettering_on_message_expiration=True,
default_message_time_to_live=datetime.timedelta(minutes=11),
duplicate_detection_history_time_window=datetime.timedelta(minutes=12),
enable_batched_operations=True,
# enable_express=True, # not enabled on premium
# enable_partitioning=True, # not enabled on premium
lock_duration=datetime.timedelta(seconds=13),
max_delivery_count=14,
max_size_in_megabytes=3072,
# requires_duplicate_detection=True, # not enabled on premium
requires_session=True,
max_message_size_in_kilobytes=12345,
)
mgmt_service.create_queue(
queue_name_2,
auto_delete_on_idle="PT10M1S",
dead_lettering_on_message_expiration=True,
default_message_time_to_live="PT11M2S",
duplicate_detection_history_time_window="PT12M3S",
enable_batched_operations=True,
lock_duration="PT13S",
max_delivery_count=14,
max_size_in_megabytes=3072,
requires_session=True,
) # default max_message_size_in_kilobytes is 1024
with pytest.raises(HttpResponseError):
mgmt_service.create_queue(queue_name_3, max_message_size_in_kilobytes=1023) # min allowed is 1024
with pytest.raises(HttpResponseError):
mgmt_service.create_queue(queue_name_3, max_message_size_in_kilobytes=102401) # max allowed is 102400
try:
queue = mgmt_service.get_queue(queue_name)
assert queue.name == queue_name
assert queue.auto_delete_on_idle == datetime.timedelta(minutes=10)
assert queue.dead_lettering_on_message_expiration == True
assert queue.default_message_time_to_live == datetime.timedelta(minutes=11)
assert queue.duplicate_detection_history_time_window == datetime.timedelta(minutes=12)
assert queue.enable_batched_operations == True
# enable_express is not supported for the premium sku, see doc
# https://learn.microsoft.com/azure/service-bus-messaging/service-bus-premium-messaging#express-entities
# assert queue.enable_express == True
# partitioning is not available for the the premium sku, see doc
# https://learn.microsoft.com/azure/service-bus-messaging/service-bus-partitioning
# assert queue.enable_partitioning == True
assert queue.lock_duration == datetime.timedelta(seconds=13)
assert queue.max_delivery_count == 14
assert (
queue.max_size_in_megabytes % 3072 == 0
) # TODO: In my local test, I don't see a multiple of the input number. To confirm
# This is disabled due to the following error:
# azure.core.exceptions.HttpResponseError: SubCode=40000. Both DelayedPersistence property and RequiresDuplicateDetection property cannot be enabled together.
# To know more visit https://aka.ms/sbResourceMgrExceptions.
# assert queue.requires_duplicate_detection == True
assert queue.requires_session == True
assert queue.max_message_size_in_kilobytes == 12345
queue_2 = mgmt_service.get_queue(queue_name_2)
assert queue_2.name == queue_name_2
assert queue_2.auto_delete_on_idle == datetime.timedelta(minutes=10, seconds=1)
assert queue_2.dead_lettering_on_message_expiration == True
assert queue_2.default_message_time_to_live == datetime.timedelta(minutes=11, seconds=2)
assert queue_2.duplicate_detection_history_time_window == datetime.timedelta(minutes=12, seconds=3)
assert queue_2.enable_batched_operations == True
assert queue_2.lock_duration == datetime.timedelta(seconds=13)
assert queue_2.max_delivery_count == 14
assert queue_2.max_size_in_megabytes % 3072 == 0
assert queue_2.requires_session == True
assert queue_2.max_message_size_in_kilobytes == 1024
queue_2.max_message_size_in_kilobytes = 54321
mgmt_service.update_queue(queue_2)
queue_2_new = mgmt_service.get_queue(queue_name_2)
assert queue_2_new.max_message_size_in_kilobytes == 54321
finally:
mgmt_service.delete_queue(queue_name)
mgmt_service.delete_queue(queue_name_2)
mgmt_service.close()
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_create_duplicate(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "rtofdk"
mgmt_service.create_queue(queue_name)
try:
with pytest.raises(ResourceExistsError):
mgmt_service.create_queue(queue_name)
finally:
mgmt_service.delete_queue(queue_name)
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_update_success(self, servicebus_connection_str, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "fjrui"
topic_name = "sagho"
queue_description = mgmt_service.create_queue(queue_name)
mgmt_service.create_topic(topic_name)
def generate_random_key():
key256 = secrets.token_bytes(32)
return base64.b64encode(key256).decode('utf-8')
auth_rule = AuthorizationRule(
type="SharedAccessAuthorizationRule",
key_name="test_key_listen",
claim_type="SharedAccessKey",
claim_value="None",
rights=[AccessRights.LISTEN],
primary_key=generate_random_key(),
secondary_key=generate_random_key(),
)
try:
# Try updating one setting.
queue_description.lock_duration = datetime.timedelta(minutes=2)
queue_description.authorization_rules = [auth_rule]
mgmt_service.update_queue(queue_description)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.lock_duration == datetime.timedelta(minutes=2)
assert queue_description.authorization_rules[0].key_name == "test_key_listen"
assert len(queue_description.authorization_rules[0].rights) == 1
# Update forwarding settings with entity name.
queue_description.forward_to = topic_name
queue_description.forward_dead_lettered_messages_to = topic_name
mgmt_service.update_queue(queue_description)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.forward_dead_lettered_messages_to.endswith(
f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}"
)
assert queue_description.forward_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{topic_name}")
# Update forwarding settings with None.
queue_description.forward_to = None
queue_description.forward_dead_lettered_messages_to = None
mgmt_service.update_queue(queue_description)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.forward_dead_lettered_messages_to is None
assert queue_description.forward_to is None
# Now try updating all settings.
queue_description.auto_delete_on_idle = datetime.timedelta(minutes=10)
queue_description.dead_lettering_on_message_expiration = True
queue_description.default_message_time_to_live = datetime.timedelta(minutes=11)
queue_description.duplicate_detection_history_time_window = datetime.timedelta(minutes=12)
queue_description.enable_batched_operations = True
queue_description.enable_express = True
# queue_description.enable_partitioning = True # Cannot be changed after creation
queue_description.lock_duration = datetime.timedelta(seconds=13)
queue_description.max_delivery_count = 14
queue_description.max_size_in_megabytes = 3072
queue_description.forward_to = f"sb://{servicebus_fully_qualified_namespace}/{queue_name}"
queue_description.forward_dead_lettered_messages_to = (
f"sb://{servicebus_fully_qualified_namespace}/{queue_name}"
)
# queue_description.requires_duplicate_detection = True # Read only
# queue_description.requires_session = True # Cannot be changed after creation
mgmt_service.update_queue(queue_description)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.auto_delete_on_idle == datetime.timedelta(minutes=10)
assert queue_description.dead_lettering_on_message_expiration == True
assert queue_description.default_message_time_to_live == datetime.timedelta(minutes=11)
assert queue_description.duplicate_detection_history_time_window == datetime.timedelta(minutes=12)
assert queue_description.enable_batched_operations == True
assert queue_description.enable_express == True
# assert queue_description.enable_partitioning == True
assert queue_description.lock_duration == datetime.timedelta(seconds=13)
assert queue_description.max_delivery_count == 14
assert queue_description.max_size_in_megabytes == 3072
# Note: We endswith to avoid the fact that the servicebus_fully_qualified_namespace_name is replacered locally but not in the properties bag, and still test this.
assert queue_description.forward_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{queue_name}")
assert queue_description.forward_dead_lettered_messages_to.endswith(
f"{SERVICEBUS_ENDPOINT_SUFFIX}/{queue_name}"
)
# assert queue_description.requires_duplicate_detection == True
# assert queue_description.requires_session == True
queue_description.auto_delete_on_idle = "PT10M1S"
queue_description.default_message_time_to_live = "PT11M2S"
queue_description.duplicate_detection_history_time_window = "PT12M3S"
mgmt_service.update_queue(queue_description)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.auto_delete_on_idle == datetime.timedelta(minutes=10, seconds=1)
assert queue_description.default_message_time_to_live == datetime.timedelta(minutes=11, seconds=2)
assert queue_description.duplicate_detection_history_time_window == datetime.timedelta(
minutes=12, seconds=3
)
# updating all settings with keyword arguments.
mgmt_service.update_queue(
queue_description,
auto_delete_on_idle=datetime.timedelta(minutes=15),
dead_lettering_on_message_expiration=False,
default_message_time_to_live=datetime.timedelta(minutes=16),
duplicate_detection_history_time_window=datetime.timedelta(minutes=17),
enable_batched_operations=False,
enable_express=False,
lock_duration=datetime.timedelta(seconds=18),
max_delivery_count=15,
max_size_in_megabytes=2048,
forward_to=None,
forward_dead_lettered_messages_to=None,
)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.auto_delete_on_idle == datetime.timedelta(minutes=15)
assert queue_description.dead_lettering_on_message_expiration == False
assert queue_description.default_message_time_to_live == datetime.timedelta(minutes=16)
assert queue_description.duplicate_detection_history_time_window == datetime.timedelta(minutes=17)
assert queue_description.enable_batched_operations == False
assert queue_description.enable_express == False
# assert queue_description.enable_partitioning == True
assert queue_description.lock_duration == datetime.timedelta(seconds=18)
assert queue_description.max_delivery_count == 15
assert queue_description.max_size_in_megabytes == 2048
# Note: We endswith to avoid the fact that the servicebus_fully_qualified_namespace_name is replacered locally but not in the properties bag, and still test this.
assert queue_description.forward_to == None
assert queue_description.forward_dead_lettered_messages_to == None
# assert queue_description.requires_duplicate_detection == True
# assert queue_description.requires_session == True
finally:
mgmt_service.delete_queue(queue_name)
mgmt_service.delete_topic(topic_name)
mgmt_service.close()
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_update_invalid(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "dfjfj"
queue_description = mgmt_service.create_queue(queue_name)
try:
# handle a null update properly.
with pytest.raises(TypeError):
mgmt_service.update_queue(None)
# handle an invalid type update properly.
with pytest.raises(TypeError):
mgmt_service.update_queue(Exception("test"))
# change a setting we can't change; should fail.
queue_description.requires_session = True
with pytest.raises(HttpResponseError):
mgmt_service.update_queue(queue_description)
queue_description.requires_session = False
# change the name to a queue that doesn't exist; should fail.
queue_description.name = "iewdm"
with pytest.raises(HttpResponseError):
mgmt_service.update_queue(queue_description)
queue_description.name = queue_name
# change the name to a queue with an invalid name exist; should fail.
queue_description.name = ""
with pytest.raises(HttpResponseError):
mgmt_service.update_queue(queue_description)
queue_description.name = queue_name
# change to a setting with an invalid value; should still fail.
queue_description.lock_duration = datetime.timedelta(days=25)
with pytest.raises(HttpResponseError):
mgmt_service.update_queue(queue_description)
queue_description.lock_duration = datetime.timedelta(minutes=5)
finally:
mgmt_service.delete_queue(queue_name)
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_runtime_properties_basic(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queues = list(mgmt_service.list_queues())
queues_infos = list(mgmt_service.list_queues_runtime_properties())
assert len(queues) == len(queues_infos) == 0
mgmt_service.create_queue("test_queue")
queues = list(mgmt_service.list_queues())
queues_infos = list(mgmt_service.list_queues_runtime_properties())
assert len(queues) == 1 and len(queues_infos) == 1
assert queues[0].name == queues_infos[0].name == "test_queue"
info = queues_infos[0]
assert info.size_in_bytes == 0
assert info.accessed_at_utc is not None
assert info.updated_at_utc is not None
assert info.total_message_count == 0
assert info.active_message_count == 0
assert info.dead_letter_message_count == 0
assert info.transfer_dead_letter_message_count == 0
assert info.transfer_message_count == 0
assert info.scheduled_message_count == 0
mgmt_service.delete_queue("test_queue")
queues_infos = list(mgmt_service.list_queues_runtime_properties())
assert len(queues_infos) == 0
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_runtime_prop_w_neg_params(self, servicebus_fully_qualified_namespace):
pytest.skip("start_idx and max_count are currently removed, they might come back in the future.")
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
run_test_mgmt_list_with_negative_parameters(MgmtQueueListRuntimeInfoTestHelper(mgmt_service))
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_list_runtime_prop_w_param(self, servicebus_fully_qualified_namespace):
pytest.skip("start_idx and max_count are currently removed, they might come back in the future.")
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
run_test_mgmt_list_with_parameters(MgmtQueueListRuntimeInfoTestHelper(mgmt_service))
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_get_runtime_properties_basic(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
mgmt_service.create_queue("test_queue")
try:
queue_runtime_properties = mgmt_service.get_queue_runtime_properties("test_queue")
assert queue_runtime_properties
assert queue_runtime_properties.name == "test_queue"
assert queue_runtime_properties.size_in_bytes == 0
assert queue_runtime_properties.created_at_utc is not None
assert queue_runtime_properties.accessed_at_utc is not None
assert queue_runtime_properties.updated_at_utc is not None
assert queue_runtime_properties.total_message_count == 0
assert queue_runtime_properties.active_message_count == 0
assert queue_runtime_properties.dead_letter_message_count == 0
assert queue_runtime_properties.transfer_dead_letter_message_count == 0
assert queue_runtime_properties.transfer_message_count == 0
assert queue_runtime_properties.scheduled_message_count == 0
finally:
mgmt_service.delete_queue("test_queue")
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_get_runtime_properties_negative(self, servicebus_fully_qualified_namespace):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
with pytest.raises(TypeError):
mgmt_service.get_queue_runtime_properties(None)
with pytest.raises(HttpResponseError):
mgmt_service.get_queue_runtime_properties("")
with pytest.raises(ResourceNotFoundError):
mgmt_service.get_queue_runtime_properties("non_existing_queue")
def test_queue_properties_constructor(self):
with pytest.raises(TypeError):
QueueProperties("randomname")
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_update_dict_success(
self, servicebus_connection_str, servicebus_fully_qualified_namespace, **kwargs
):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "fjruid"
queue_description = mgmt_service.create_queue(queue_name)
queue_description_dict = dict(queue_description)
try:
# Try updating one setting.
queue_description_dict["lock_duration"] = datetime.timedelta(minutes=2)
mgmt_service.update_queue(queue_description_dict)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.lock_duration == datetime.timedelta(minutes=2)
# Now try updating all settings.
queue_description_dict = dict(queue_description)
queue_description_dict["auto_delete_on_idle"] = datetime.timedelta(minutes=10)
queue_description_dict["dead_lettering_on_message_expiration"] = True
queue_description_dict["default_message_time_to_live"] = datetime.timedelta(minutes=11)
queue_description_dict["duplicate_detection_history_time_window"] = datetime.timedelta(minutes=12)
queue_description_dict["enable_batched_operations"] = True
queue_description_dict["enable_express"] = True
# queue_description_dict["enable_partitioning"] = True # Cannot be changed after creation
queue_description_dict["lock_duration"] = datetime.timedelta(seconds=13)
queue_description_dict["max_delivery_count"] = 14
queue_description_dict["max_size_in_megabytes"] = 3072
queue_description_dict["forward_to"] = f"sb://{servicebus_fully_qualified_namespace}/{queue_name}"
queue_description_dict["forward_dead_lettered_messages_to"] = (
f"sb://{servicebus_fully_qualified_namespace}/{queue_name}"
)
# queue_description_dict["requires_duplicate_detection"] = True # Read only
# queue_description_dict["requires_session"] = True # Cannot be changed after creation
mgmt_service.update_queue(queue_description_dict)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.auto_delete_on_idle == datetime.timedelta(minutes=10)
assert queue_description.dead_lettering_on_message_expiration == True
assert queue_description.default_message_time_to_live == datetime.timedelta(minutes=11)
assert queue_description.duplicate_detection_history_time_window == datetime.timedelta(minutes=12)
assert queue_description.enable_batched_operations == True
assert queue_description.enable_express == True
# assert queue_description.enable_partitioning == True
assert queue_description.lock_duration == datetime.timedelta(seconds=13)
assert queue_description.max_delivery_count == 14
assert queue_description.max_size_in_megabytes == 3072
# Note: We endswith to avoid the fact that the servicebus_fully_qualified_namespace_name is replacered locally but not in the properties bag, and still test this.
assert queue_description.forward_to.endswith(f"{SERVICEBUS_ENDPOINT_SUFFIX}/{queue_name}")
assert queue_description.forward_dead_lettered_messages_to.endswith(
f"{SERVICEBUS_ENDPOINT_SUFFIX}/{queue_name}"
)
# assert queue_description.requires_duplicate_detection == True
# assert queue_description.requires_session == True
# updating all settings with keyword arguments.
mgmt_service.update_queue(
dict(queue_description),
auto_delete_on_idle=datetime.timedelta(minutes=15),
dead_lettering_on_message_expiration=False,
default_message_time_to_live=datetime.timedelta(minutes=16),
duplicate_detection_history_time_window=datetime.timedelta(minutes=17),
enable_batched_operations=False,
enable_express=False,
lock_duration=datetime.timedelta(seconds=18),
max_delivery_count=15,
max_size_in_megabytes=2048,
forward_to=None,
forward_dead_lettered_messages_to=None,
)
queue_description = mgmt_service.get_queue(queue_name)
assert queue_description.auto_delete_on_idle == datetime.timedelta(minutes=15)
assert queue_description.dead_lettering_on_message_expiration == False
assert queue_description.default_message_time_to_live == datetime.timedelta(minutes=16)
assert queue_description.duplicate_detection_history_time_window == datetime.timedelta(minutes=17)
assert queue_description.enable_batched_operations == False
assert queue_description.enable_express == False
# assert queue_description.enable_partitioning == True
assert queue_description.lock_duration == datetime.timedelta(seconds=18)
assert queue_description.max_delivery_count == 15
assert queue_description.max_size_in_megabytes == 2048
# Note: We endswith to avoid the fact that the servicebus_fully_qualified_namespace_name is replacered locally but not in the properties bag, and still test this.
assert queue_description.forward_to == None
assert queue_description.forward_dead_lettered_messages_to == None
# assert queue_description.requires_duplicate_detection == True
# assert queue_description.requires_session == True
finally:
mgmt_service.delete_queue(queue_name)
mgmt_service.close()
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_update_dict_error(self, servicebus_fully_qualified_namespace, **kwargs):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace, credential=credential
)
clear_queues(mgmt_service)
queue_name = "dfjdfj"
queue_description = mgmt_service.create_queue(queue_name)
# send in queue dict without non-name keyword args
queue_description_only_name = {"name": queue_name}
try:
with pytest.raises(TypeError):
mgmt_service.update_queue(queue_description_only_name)
finally:
mgmt_service.delete_queue(queue_name)
@ServiceBusPreparer()
@recorded_by_proxy
def test_mgmt_queue_basic_v2017_04(
self, servicebus_connection_str, servicebus_fully_qualified_namespace, servicebus_sas_policy, servicebus_sas_key
):
credential = get_credential()
mgmt_service = ServiceBusAdministrationClient(
fully_qualified_namespace=servicebus_fully_qualified_namespace,
credential=credential,
api_version=ApiVersion.V2017_04,
)
clear_queues(mgmt_service)
mgmt_service.create_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 1 and queues[0].name == "test_queue"
queue = mgmt_service.get_queue("test_queue")
assert queue.name == "test_queue"
mgmt_service.delete_queue("test_queue")
queues = list(mgmt_service.list_queues())
assert len(queues) == 0
with pytest.raises(HttpResponseError):
mgmt_service.create_queue("queue_can_not_be_created", max_message_size_in_kilobytes=1024)
# mgmt_service = ServiceBusAdministrationClient(
# servicebus_fully_qualified_namespace,
# credential=ServiceBusSharedKeyCredential(servicebus_sas_policy, servicebus_sas_key),
# api_version=ApiVersion.V2017_04
# )
# mgmt_service.create_queue("test_queue")
# queues = list(mgmt_service.list_queues())
# assert len(queues) == 1 and queues[0].name == "test_queue"
# queue = mgmt_service.get_queue("test_queue")
# assert queue.name == "test_queue"
# mgmt_service.delete_queue("test_queue")
# queues = list(mgmt_service.list_queues())
# assert len(queues) == 0
# with pytest.raises(HttpResponseError):
# mgmt_service.create_queue("queue_can_not_be_created", max_message_size_in_kilobytes=1024)
|