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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import logging
import sys
import os
import pytest
import time
from datetime import datetime, timedelta
import hmac
import hashlib
import base64
import certifi
import ssl
try:
from urllib.parse import quote as url_parse_quote
except ImportError:
from urllib import pathname2url as url_parse_quote
try:
from azure.servicebus._transport._uamqp_transport import UamqpTransport
except ImportError:
pass
from azure.servicebus._transport._pyamqp_transport import PyamqpTransport
from azure.common import AzureHttpError, AzureConflictHttpError
from azure.core.credentials import AzureSasCredential, AzureNamedKeyCredential, AccessToken
from azure.core.pipeline.policies import RetryMode
from azure.mgmt.servicebus.models import AccessRights
from azure.servicebus import ServiceBusClient, ServiceBusSender, ServiceBusReceiver
from azure.servicebus._base_handler import ServiceBusSharedKeyCredential
from azure.servicebus._common.message import ServiceBusMessage, ServiceBusReceivedMessage
from azure.servicebus.exceptions import (
ServiceBusError,
ServiceBusAuthenticationError,
ServiceBusAuthorizationError,
ServiceBusConnectionError,
)
from devtools_testutils import AzureMgmtRecordedTestCase, get_credential
from servicebus_preparer import (
CachedServiceBusNamespacePreparer,
ServiceBusTopicPreparer,
ServiceBusQueuePreparer,
ServiceBusNamespaceAuthorizationRulePreparer,
ServiceBusQueueAuthorizationRulePreparer,
CachedServiceBusQueuePreparer,
CachedServiceBusTopicPreparer,
CachedServiceBusSubscriptionPreparer,
CachedServiceBusResourceGroupPreparer,
SERVICEBUS_ENDPOINT_SUFFIX,
)
from utilities import (
uamqp_transport as get_uamqp_transport,
ArgPasser,
socket_transport as get_socket_transport,
SocketArgPasser,
)
uamqp_transport_params, uamqp_transport_ids = get_uamqp_transport()
socket_transport_params, socket_transport_ids = get_socket_transport()
class TestServiceBusClient(AzureMgmtRecordedTestCase):
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusQueuePreparer(name_prefix="servicebustest", dead_lettering_on_message_expiration=True)
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_bad_credentials(
self, uamqp_transport, *, servicebus_namespace=None, servicebus_queue=None, **kwargs
):
client = ServiceBusClient(
fully_qualified_namespace=servicebus_namespace.name + f"{SERVICEBUS_ENDPOINT_SUFFIX}",
credential=ServiceBusSharedKeyCredential("invalid", "invalid"),
logging_enable=False,
uamqp_transport=uamqp_transport,
)
with client:
with pytest.raises(ServiceBusAuthenticationError):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
@pytest.mark.liveTest
@pytest.mark.live_test_only
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_sb_client_bad_namespace(self, uamqp_transport, **kwargs):
client = ServiceBusClient(
fully_qualified_namespace=f"invalid{SERVICEBUS_ENDPOINT_SUFFIX}",
credential=ServiceBusSharedKeyCredential("invalid", "invalid"),
logging_enable=False,
uamqp_transport=uamqp_transport,
)
with client:
with pytest.raises(ServiceBusError):
with client.get_queue_sender("invalidqueue") as sender:
sender.send_messages(ServiceBusMessage("test"))
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_bad_entity(
self, uamqp_transport, *, servicebus_namespace_connection_string=None, servicebus_namespace=None, **kwargs
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = get_credential()
client = ServiceBusClient(fully_qualified_namespace, credential, uamqp_transport=uamqp_transport)
with client:
with pytest.raises(ServiceBusAuthenticationError):
with client.get_queue_sender("invalid") as sender:
sender.send_messages(ServiceBusMessage("test"))
fake_str = (
f"Endpoint=sb://mock{SERVICEBUS_ENDPOINT_SUFFIX}/;"
f"SharedAccessKeyName=mock;SharedAccessKey=mock;EntityPath=mockentity"
)
fake_client = ServiceBusClient.from_connection_string(fake_str, uamqp_transport=uamqp_transport)
with pytest.raises(ValueError):
fake_client.get_queue_sender("queue")
with pytest.raises(ValueError):
fake_client.get_queue_receiver("queue")
with pytest.raises(ValueError):
fake_client.get_topic_sender("topic")
with pytest.raises(ValueError):
fake_client.get_subscription_receiver("topic", "subscription")
fake_client.get_queue_sender("mockentity")
fake_client.get_queue_receiver("mockentity")
fake_client.get_topic_sender("mockentity")
fake_client.get_subscription_receiver("mockentity", "subscription")
fake_str = f"Endpoint=sb://mock{SERVICEBUS_ENDPOINT_SUFFIX}/;" f"SharedAccessKeyName=mock;SharedAccessKey=mock"
fake_client = ServiceBusClient.from_connection_string(fake_str, uamqp_transport=uamqp_transport)
fake_client.get_queue_sender("queue")
fake_client.get_queue_receiver("queue")
fake_client.get_topic_sender("topic")
fake_client.get_subscription_receiver("topic", "subscription")
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusQueuePreparer(name_prefix="servicebustest", dead_lettering_on_message_expiration=True)
@ServiceBusNamespaceAuthorizationRulePreparer(name_prefix="servicebustest", access_rights=[AccessRights.listen])
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_readonly_credentials(
self, uamqp_transport, *, servicebus_authorization_rule_connection_string=None, servicebus_queue=None, **kwargs
):
client = ServiceBusClient.from_connection_string(
servicebus_authorization_rule_connection_string, uamqp_transport=uamqp_transport
)
with client:
with client.get_queue_receiver(servicebus_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
with pytest.raises(ServiceBusAuthorizationError):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusQueuePreparer(name_prefix="servicebustest", dead_lettering_on_message_expiration=True)
@ServiceBusNamespaceAuthorizationRulePreparer(name_prefix="servicebustest", access_rights=[AccessRights.send])
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_writeonly_credentials(
self, uamqp_transport, *, servicebus_authorization_rule_connection_string=None, servicebus_queue=None, **kwargs
):
client = ServiceBusClient.from_connection_string(
servicebus_authorization_rule_connection_string, uamqp_transport=uamqp_transport
)
with client:
with pytest.raises(ServiceBusError):
with client.get_queue_receiver(servicebus_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
with pytest.raises(TypeError):
sender.send_messages("cat")
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusNamespaceAuthorizationRulePreparer(name_prefix="servicebustest")
@ServiceBusQueuePreparer(
name_prefix="servicebustest_qone", parameter_name="wrong_queue", dead_lettering_on_message_expiration=True
)
@ServiceBusQueuePreparer(name_prefix="servicebustest_qtwo", dead_lettering_on_message_expiration=True)
@ServiceBusQueueAuthorizationRulePreparer(name_prefix="servicebustest_qtwo")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_incorrect_queue_conn_str(
self,
uamqp_transport,
*,
servicebus_queue_authorization_rule_connection_string=None,
servicebus_queue=None,
wrong_queue=None,
**kwargs,
):
if uamqp_transport:
amqp_transport = UamqpTransport
else:
amqp_transport = PyamqpTransport
client = ServiceBusClient.from_connection_string(
servicebus_queue_authorization_rule_connection_string, uamqp_transport=uamqp_transport
)
with client:
# Validate that the wrong sender/receiver queues with the right credentials fail.
with pytest.raises(ValueError):
with client.get_queue_sender(wrong_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
with pytest.raises(ValueError):
with client.get_queue_receiver(wrong_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
# But that the correct ones work.
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
with client.get_queue_receiver(servicebus_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
# Now do the same but with direct connstr initialization.
with pytest.raises(ValueError):
with ServiceBusSender._from_connection_string(
servicebus_queue_authorization_rule_connection_string,
queue_name=wrong_queue.name,
amqp_transport=amqp_transport,
) as sender:
sender.send_messages(ServiceBusMessage("test"))
with pytest.raises(ValueError):
with ServiceBusReceiver._from_connection_string(
servicebus_queue_authorization_rule_connection_string,
queue_name=wrong_queue.name,
amqp_transport=amqp_transport,
) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
with ServiceBusSender._from_connection_string(
servicebus_queue_authorization_rule_connection_string,
queue_name=servicebus_queue.name,
amqp_transport=amqp_transport,
) as sender:
sender.send_messages(ServiceBusMessage("test"))
with ServiceBusReceiver._from_connection_string(
servicebus_queue_authorization_rule_connection_string,
queue_name=servicebus_queue.name,
amqp_transport=amqp_transport,
) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest", dead_lettering_on_message_expiration=True)
@CachedServiceBusTopicPreparer(name_prefix="servicebustest")
@CachedServiceBusSubscriptionPreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_sb_client_close_spawned_handlers(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_queue=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = get_credential()
client = ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace, credential=credential, uamqp_transport=uamqp_transport
)
client.close()
# context manager
with client:
assert len(client._handlers) == 0
sender = client.get_queue_sender(servicebus_queue.name)
receiver = client.get_queue_receiver(servicebus_queue.name)
sender._open()
receiver._open()
assert sender._handler and sender._running
assert receiver._handler and receiver._running
assert len(client._handlers) == 2
assert not sender._handler and not sender._running
assert not receiver._handler and not receiver._running
assert len(client._handlers) == 0
# close operation
sender = client.get_queue_sender(servicebus_queue.name)
receiver = client.get_queue_receiver(servicebus_queue.name)
sender._open()
receiver._open()
assert sender._handler and sender._running
assert receiver._handler and receiver._running
assert len(client._handlers) == 2
client.close()
assert not sender._handler and not sender._running
assert not receiver._handler and not receiver._running
assert len(client._handlers) == 0
queue_sender = client.get_queue_sender(servicebus_queue.name)
queue_receiver = client.get_queue_receiver(servicebus_queue.name)
assert len(client._handlers) == 2
queue_sender = client.get_queue_sender(servicebus_queue.name)
queue_receiver = client.get_queue_receiver(servicebus_queue.name)
# the previous sender/receiver can not longer be referenced, there might be a delay in CPython
# to remove the reference, so len of handlers should be less than 4
assert len(client._handlers) < 4
client.close()
queue_sender = client.get_queue_sender(servicebus_queue.name)
queue_receiver = client.get_queue_receiver(servicebus_queue.name)
assert len(client._handlers) == 2
queue_sender = None
queue_receiver = None
assert len(client._handlers) < 2
client.close()
topic_sender = client.get_topic_sender(servicebus_topic.name)
subscription_receiver = client.get_subscription_receiver(servicebus_topic.name, servicebus_subscription.name)
assert len(client._handlers) == 2
topic_sender = None
subscription_receiver = None
# the previous sender/receiver can not longer be referenced, so len of handlers should just be 2 instead of 4
assert len(client._handlers) < 4
client.close()
topic_sender = client.get_topic_sender(servicebus_topic.name)
subscription_receiver = client.get_subscription_receiver(servicebus_topic.name, servicebus_subscription.name)
assert len(client._handlers) == 2
topic_sender = client.get_topic_sender(servicebus_topic.name)
subscription_receiver = client.get_subscription_receiver(servicebus_topic.name, servicebus_subscription.name)
# the previous sender/receiver can not longer be referenced, so len of handlers should just be 2 instead of 4
assert len(client._handlers) < 4
client.close()
for _ in range(5):
queue_sender = client.get_queue_sender(servicebus_queue.name)
queue_receiver = client.get_queue_receiver(servicebus_queue.name)
topic_sender = client.get_topic_sender(servicebus_topic.name)
subscription_receiver = client.get_subscription_receiver(
servicebus_topic.name, servicebus_subscription.name
)
assert len(client._handlers) < 15
client.close()
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_client_sas_credential(
self,
uamqp_transport,
*,
servicebus_queue,
servicebus_namespace,
servicebus_namespace_key_name,
servicebus_namespace_primary_key,
servicebus_namespace_connection_string,
**kwargs,
):
# This should "just work" to validate known-good.
credential = ServiceBusSharedKeyCredential(servicebus_namespace_key_name, servicebus_namespace_primary_key)
hostname = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
auth_uri = "sb://{}/{}".format(hostname, servicebus_queue.name)
token = credential.get_token(auth_uri).token
# Finally let's do it with SAS token + conn str
token_conn_str = "Endpoint=sb://{}/;SharedAccessSignature={};".format(hostname, token)
client = ServiceBusClient.from_connection_string(token_conn_str, uamqp_transport=uamqp_transport)
with client:
assert len(client._handlers) == 0
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
# This is disabled pending UAMQP fix https://github.com/Azure/azure-uamqp-python/issues/170
#
# token_conn_str_without_se = token_conn_str.split('se=')[0] + token_conn_str.split('se=')[1].split('&')[1]
#
# client = ServiceBusClient.from_connection_string(token_conn_str_without_se, uamqp_transport=uamqp_transport)
# with client:
# assert len(client._handlers) == 0
# with client.get_queue_sender(servicebus_queue.name) as sender:
# sender.send_messages(ServiceBusMessage("foo"))
def generate_sas_token(uri, sas_name, sas_value, token_ttl):
"""Performs the signing and encoding needed to generate a sas token from a sas key."""
sas = sas_value.encode("utf-8")
expiry = str(int(time.time() + token_ttl))
string_to_sign = (uri + "\n" + expiry).encode("utf-8")
signed_hmac_sha256 = hmac.HMAC(sas, string_to_sign, hashlib.sha256)
signature = url_parse_quote(base64.b64encode(signed_hmac_sha256.digest()))
return "SharedAccessSignature sr={}&sig={}&se={}&skn={}".format(uri, signature, expiry, sas_name)
class CustomizedSASCredential(object):
def __init__(self, token, expiry):
"""
:param str token: The token string
:param float expiry: The epoch timestamp
"""
self.token = token
self.expiry = expiry
self.token_type = b"servicebus.windows.net:sastoken"
def get_token(self, *scopes, **kwargs):
"""
This method is automatically called when token is about to expire.
"""
return AccessToken(self.token, self.expiry)
token_ttl = 5 # seconds
sas_token = generate_sas_token(
auth_uri, servicebus_namespace_key_name, servicebus_namespace_primary_key, token_ttl
)
credential = CustomizedSASCredential(sas_token, time.time() + token_ttl)
with ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport) as client:
sender = client.get_queue_sender(queue_name=servicebus_queue.name)
time.sleep(10)
with pytest.raises(ServiceBusAuthenticationError):
with sender:
message = ServiceBusMessage("Single Message")
sender.send_messages(message)
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_client_credential(
self,
uamqp_transport,
*,
servicebus_queue=None,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_namespace_connection_string=None,
**kwargs,
):
# This should "just work" to validate known-good.
credential = ServiceBusSharedKeyCredential(servicebus_namespace_key_name, servicebus_namespace_primary_key)
hostname = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
client = ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport)
with client:
assert len(client._handlers) == 0
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
hostname = f"sb://{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
client = ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport)
with client:
assert len(client._handlers) == 0
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
hostname = f"https://{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
client = ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport)
with client:
assert len(client._handlers) == 0
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_client_azure_sas_credential(
self,
uamqp_transport,
*,
servicebus_queue=None,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_namespace_connection_string=None,
**kwargs,
):
# This should "just work" to validate known-good.
credential = ServiceBusSharedKeyCredential(servicebus_namespace_key_name, servicebus_namespace_primary_key)
hostname = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
auth_uri = "sb://{}/{}".format(hostname, servicebus_queue.name)
token = credential.get_token(auth_uri).token
# Finally let's do it with AzureSasCredential
credential = AzureSasCredential(token)
client = ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport)
with client:
assert len(client._handlers) == 0
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_azure_named_key_credential(
self,
uamqp_transport,
*,
servicebus_queue=None,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_namespace_connection_string=None,
**kwargs,
):
hostname = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = AzureNamedKeyCredential(servicebus_namespace_key_name, servicebus_namespace_primary_key)
client = ServiceBusClient(hostname, credential, uamqp_transport=uamqp_transport)
with client:
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
credential.update("foo", "bar")
with pytest.raises(Exception):
with client:
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
# update back to the right key again
credential.update(servicebus_namespace_key_name, servicebus_namespace_primary_key)
with client:
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest", dead_lettering_on_message_expiration=True)
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@pytest.mark.parametrize("socket_transport", socket_transport_params, ids=socket_transport_ids)
@SocketArgPasser()
def test_sb_client_with_ssl_context(
self,
uamqp_transport,
socket_transport,
*,
servicebus_namespace=None,
servicebus_queue=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = get_credential()
# Check that SSLContext with invalid/nonexistent cert file raises an error
context = ssl.SSLContext(cafile="fakecert.pem")
context.verify_mode = ssl.CERT_REQUIRED
client = ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=credential,
uamqp_transport=uamqp_transport,
ssl_context=context,
transport_type=socket_transport,
retry_total=0,
)
with client:
with pytest.raises(ServiceBusConnectionError):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
with pytest.raises(ServiceBusConnectionError):
with client.get_queue_receiver(servicebus_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=1, max_wait_time=1)
# Check that SSLContext with valid cert file doesn't raise an error
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.load_verify_locations(certifi.where())
purpose = ssl.Purpose.SERVER_AUTH
context.load_default_certs(purpose=purpose)
client = ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=credential,
uamqp_transport=uamqp_transport,
ssl_context=context,
transport_type=socket_transport,
)
with client:
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("test"))
sender.send_messages(ServiceBusMessage("test"))
with client.get_queue_receiver(servicebus_queue.name) as receiver:
messages = receiver.receive_messages(max_message_count=2, max_wait_time=10)
assert len(messages) == 2
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_backoff_fixed_retry(self, uamqp_transport):
client = ServiceBusClient("fake.host.com", "fake_eh", retry_mode="fixed", uamqp_transport=uamqp_transport)
# queue sender
sender = client.get_queue_sender("fake_name")
backoff = client._config.retry_backoff_factor
start_time = time.time()
sender._backoff(retried_times=1, last_exception=Exception("fake"), abs_timeout_time=None)
sleep_time_fixed = time.time() - start_time
# exp = 0.8 * (2 ** 1) = 1.6
# time.sleep() in _backoff will take AT LEAST time 'exp' for retry_mode='exponential'
# check that fixed is less than 'exp'
assert sleep_time_fixed < backoff * (2**1)
# topic sender
sender = client.get_topic_sender("fake_name")
backoff = client._config.retry_backoff_factor
start_time = time.time()
sender._backoff(retried_times=1, last_exception=Exception("fake"), abs_timeout_time=None)
sleep_time_fixed = time.time() - start_time
assert sleep_time_fixed < backoff * (2**1)
# queue receiver
receiver = client.get_queue_receiver("fake_name")
backoff = client._config.retry_backoff_factor
start_time = time.time()
receiver._backoff(retried_times=1, last_exception=Exception("fake"), abs_timeout_time=None)
sleep_time_fixed = time.time() - start_time
assert sleep_time_fixed < backoff * (2**1)
# subscription receiver
receiver = client.get_subscription_receiver("fake_topic", "fake_sub")
backoff = client._config.retry_backoff_factor
start_time = time.time()
receiver._backoff(retried_times=1, last_exception=Exception("fake"), abs_timeout_time=None)
sleep_time_fixed = time.time() - start_time
assert sleep_time_fixed < backoff * (2**1)
client = ServiceBusClient(
"fake.host.com", "fake_eh", retry_mode=RetryMode.Fixed, uamqp_transport=uamqp_transport
)
# queue sender
sender = client.get_queue_sender("fake_name")
backoff = client._config.retry_backoff_factor
start_time = time.time()
sender._backoff(retried_times=1, last_exception=Exception("fake"), abs_timeout_time=None)
sleep_time_fixed = time.time() - start_time
# exp = 0.8 * (2 ** 1) = 1.6
# time.sleep() in _backoff will take AT LEAST time 'exp' for retry_mode='exponential'
# check that fixed is less than 'exp'
assert sleep_time_fixed < backoff * (2**1)
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_custom_client_id_queue_sender(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
queue_name = "queue_name"
custom_id = "my_custom_id"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name, client_identifier=custom_id)
assert queue_sender.client_identifier is not None
assert queue_sender.client_identifier == custom_id
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_default_client_id_queue_sender(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
queue_name = "queue_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
queue_sender = servicebus_client.get_queue_sender(queue_name=queue_name)
assert queue_sender.client_identifier is not None
assert "SBSender" in queue_sender.client_identifier
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_custom_client_id_queue_receiver(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
queue_name = "queue_name"
custom_id = "my_custom_id"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name, client_identifier=custom_id)
assert queue_receiver.client_identifier is not None
assert queue_receiver.client_identifier == custom_id
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_default_client_id_queue_receiver(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
queue_name = "queue_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
queue_receiver = servicebus_client.get_queue_receiver(queue_name=queue_name)
assert queue_receiver.client_identifier is not None
assert "SBReceiver" in queue_receiver.client_identifier
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_custom_client_id_topic_sender(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
custom_id = "my_custom_id"
topic_name = "topic_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
topic_sender = servicebus_client.get_topic_sender(topic_name=topic_name, client_identifier=custom_id)
assert topic_sender.client_identifier is not None
assert topic_sender.client_identifier == custom_id
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_default_client_id_topic_sender(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
topic_name = "topic_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
topic_sender = servicebus_client.get_topic_sender(topic_name=topic_name)
assert topic_sender.client_identifier is not None
assert "SBSender" in topic_sender.client_identifier
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_default_client_id_subscription_receiver(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
topic_name = "topic_name"
sub_name = "sub_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
subscription_receiver = servicebus_client.get_subscription_receiver(topic_name, sub_name)
assert subscription_receiver.client_identifier is not None
assert "SBReceiver" in subscription_receiver.client_identifier
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
def test_custom_client_id_subscription_receiver(self, uamqp_transport, **kwargs):
servicebus_connection_str = f"Endpoint=sb://resourcename{SERVICEBUS_ENDPOINT_SUFFIX}/;SharedAccessSignature=THISISATESTKEYXXXXXXXXXXXXXXXXXXXXXXXXXXXX=;"
custom_id = "my_custom_id"
topic_name = "topic_name"
sub_name = "sub_name"
servicebus_client = ServiceBusClient.from_connection_string(
conn_str=servicebus_connection_str, uamqp_transport=uamqp_transport
)
with servicebus_client:
subscription_receiver = servicebus_client.get_subscription_receiver(
topic_name, sub_name, client_identifier=custom_id
)
assert subscription_receiver.client_identifier is not None
assert subscription_receiver.client_identifier == custom_id
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer()
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@CachedServiceBusQueuePreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasser()
def test_custom_endpoint_connection_verify_exception(
self,
uamqp_transport,
*,
servicebus_queue=None,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_namespace_connection_string=None,
**kwargs,
):
hostname = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = AzureNamedKeyCredential(servicebus_namespace_key_name, servicebus_namespace_primary_key)
# ensure regular connection_verify works
certfile = certifi.where()
client = ServiceBusClient(hostname, credential, connection_verify=certfile, uamqp_transport=uamqp_transport)
with client:
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
# invalid cert file to connection_verify should fail
client = ServiceBusClient(
hostname, credential, connection_verify="fakecertfile.pem", uamqp_transport=uamqp_transport
)
with client:
with pytest.raises(ServiceBusError):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
# Skipping on OSX uamqp - it's raising an Authentication/TimeoutError
if not uamqp_transport or not sys.platform.startswith("darwin"):
# invalid custom endpoint should fail
fake_addr = "fakeaddress.com:1111"
client = ServiceBusClient(
hostname, credential, custom_endpoint_address=fake_addr, retry_total=0, uamqp_transport=uamqp_transport
)
with client:
if not uamqp_transport:
error = ServiceBusConnectionError
else:
# if uamqp, catches an "Authorization timeout" error and raises ServiceBusError
error = ServiceBusError
with pytest.raises(error):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
client = ServiceBusClient(
hostname,
credential,
custom_endpoint_address=fake_addr,
connection_verify=certfile,
retry_total=0,
uamqp_transport=uamqp_transport,
)
with client:
with pytest.raises(ServiceBusError):
with client.get_queue_sender(servicebus_queue.name) as sender:
sender.send_messages(ServiceBusMessage("foo"))
|