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
|
# -------------------------------------------------------------------------
# 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 asyncio
import pytest
import time
from datetime import datetime, timedelta
from azure.servicebus import ServiceBusMessage, ServiceBusReceiveMode
from azure.servicebus.aio import ServiceBusClient
from azure.servicebus.aio._base_handler_async import ServiceBusSharedKeyCredential
from azure.servicebus.exceptions import ServiceBusError, MessageLockLostError
from azure.servicebus._common.constants import ServiceBusSubQueue
from devtools_testutils import AzureMgmtRecordedTestCase, RandomNameResourceGroupPreparer, get_credential
from servicebus_preparer import (
CachedServiceBusNamespacePreparer,
CachedServiceBusTopicPreparer,
CachedServiceBusSubscriptionPreparer,
ServiceBusTopicPreparer,
ServiceBusSubscriptionPreparer,
CachedServiceBusResourceGroupPreparer,
SERVICEBUS_ENDPOINT_SUFFIX,
)
from utilities import get_logger, print_message, uamqp_transport as get_uamqp_transport, ArgPasserAsync
uamqp_transport_params, uamqp_transport_ids = get_uamqp_transport()
_logger = get_logger(logging.DEBUG)
class TestServiceBusSubscriptionAsync(AzureMgmtRecordedTestCase):
@pytest.mark.asyncio
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusTopicPreparer(name_prefix="servicebustest")
@ServiceBusSubscriptionPreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasserAsync()
async def test_subscription_by_subscription_client_conn_str_receive_basic(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = get_credential(is_async=True)
async with ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=credential,
logging_enable=False,
uamqp_transport=uamqp_transport,
) as sb_client:
async with sb_client.get_topic_sender(topic_name=servicebus_topic.name) as sender:
message = ServiceBusMessage(b"Sample topic message")
await sender.send_messages(message)
with pytest.raises(ValueError):
sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name, subscription_name=servicebus_subscription.name, max_wait_time=0
)
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name, subscription_name=servicebus_subscription.name, max_wait_time=10
) as receiver:
with pytest.raises(ValueError):
await receiver.receive_messages(max_wait_time=-1)
count = 0
async for message in receiver:
count += 1
await receiver.complete_message(message)
assert count == 1
@pytest.mark.asyncio
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusTopicPreparer(name_prefix="servicebustest")
@ServiceBusSubscriptionPreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasserAsync()
async def test_subscription_by_sas_token_credential_conn_str_send_basic(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
async with ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=ServiceBusSharedKeyCredential(
policy=servicebus_namespace_key_name, key=servicebus_namespace_primary_key
),
logging_enable=False,
uamqp_transport=uamqp_transport,
) as sb_client:
async with sb_client.get_topic_sender(topic_name=servicebus_topic.name) as sender:
message = ServiceBusMessage(b"Sample topic message")
await sender.send_messages(message)
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name, subscription_name=servicebus_subscription.name, max_wait_time=5
) as receiver:
count = 0
async for message in receiver:
count += 1
await receiver.complete_message(message)
assert count == 1
@pytest.mark.asyncio
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusTopicPreparer(name_prefix="servicebustest")
@ServiceBusSubscriptionPreparer(name_prefix="servicebustest")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasserAsync()
async def test_topic_by_servicebus_client_receive_batch_with_deadletter(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
credential = get_credential(is_async=True)
async with ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=credential,
logging_enable=False,
uamqp_transport=uamqp_transport,
) as sb_client:
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name,
subscription_name=servicebus_subscription.name,
max_wait_time=5,
receive_mode=ServiceBusReceiveMode.PEEK_LOCK,
prefetch_count=10,
) as receiver:
async with sb_client.get_topic_sender(servicebus_topic.name) as sender:
for i in range(10):
message = ServiceBusMessage("Dead lettered message no. {}".format(i))
await sender.send_messages(message)
count = 0
messages = await receiver.receive_messages()
while messages:
for message in messages:
print_message(_logger, message)
count += 1
await receiver.dead_letter_message(
message, reason="Testing reason", error_description="Testing description"
)
messages = await receiver.receive_messages()
assert count == 10
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name,
subscription_name=servicebus_subscription.name,
max_wait_time=5,
receive_mode=ServiceBusReceiveMode.PEEK_LOCK,
) as receiver:
count = 0
async for message in receiver:
print_message(_logger, message)
await receiver.complete_message(message)
count += 1
assert count == 0
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name,
subscription_name=servicebus_subscription.name,
sub_queue=ServiceBusSubQueue.DEAD_LETTER,
max_wait_time=5,
receive_mode=ServiceBusReceiveMode.PEEK_LOCK,
) as dl_receiver:
count = 0
async for message in dl_receiver:
await dl_receiver.complete_message(message)
count += 1
assert message.dead_letter_reason == "Testing reason"
assert message.dead_letter_error_description == "Testing description"
assert message.application_properties[b"DeadLetterReason"] == b"Testing reason"
assert message.application_properties[b"DeadLetterErrorDescription"] == b"Testing description"
assert count == 10
@pytest.mark.asyncio
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusTopicPreparer(name_prefix="servicebustest")
@ServiceBusSubscriptionPreparer(name_prefix="servicebustest", lock_duration="PT5S")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasserAsync()
async def test_subscription_message_expiry(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
async with ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=ServiceBusSharedKeyCredential(
policy=servicebus_namespace_key_name, key=servicebus_namespace_primary_key
),
logging_enable=False,
uamqp_transport=uamqp_transport,
) as sb_client:
async with sb_client.get_topic_sender(topic_name=servicebus_topic.name) as sender:
message = ServiceBusMessage(b"Testing topic message expiry")
await sender.send_messages(message)
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name, subscription_name=servicebus_subscription.name
) as receiver:
messages = await receiver.receive_messages(max_wait_time=10)
assert len(messages) == 1
time.sleep(10)
assert messages[0]._lock_expired
with pytest.raises(MessageLockLostError):
await receiver.complete_message(messages[0])
with pytest.raises(MessageLockLostError):
await receiver.renew_message_lock(messages[0])
async with sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name, subscription_name=servicebus_subscription.name
) as receiver:
messages = await receiver.receive_messages(max_wait_time=10)
assert len(messages) == 1
assert messages[0].delivery_count > 0
await receiver.complete_message(messages[0])
@pytest.mark.asyncio
@pytest.mark.liveTest
@pytest.mark.live_test_only
@CachedServiceBusResourceGroupPreparer(name_prefix="servicebustest")
@CachedServiceBusNamespacePreparer(name_prefix="servicebustest")
@ServiceBusTopicPreparer(name_prefix="servicebustest")
@ServiceBusSubscriptionPreparer(name_prefix="servicebustest", lock_duration="PT5S")
@pytest.mark.parametrize("uamqp_transport", uamqp_transport_params, ids=uamqp_transport_ids)
@ArgPasserAsync()
async def test_subscription_receive_and_delete_with_send_and_wait(
self,
uamqp_transport,
*,
servicebus_namespace=None,
servicebus_namespace_key_name=None,
servicebus_namespace_primary_key=None,
servicebus_topic=None,
servicebus_subscription=None,
**kwargs,
):
fully_qualified_namespace = f"{servicebus_namespace.name}{SERVICEBUS_ENDPOINT_SUFFIX}"
async with ServiceBusClient(
fully_qualified_namespace=fully_qualified_namespace,
credential=ServiceBusSharedKeyCredential(
policy=servicebus_namespace_key_name, key=servicebus_namespace_primary_key
),
logging_enable=False,
uamqp_transport=uamqp_transport,
) as sb_client:
sender = sb_client.get_topic_sender(topic_name=servicebus_topic.name)
receiver = sb_client.get_subscription_receiver(
topic_name=servicebus_topic.name,
subscription_name=servicebus_subscription.name,
receive_mode=ServiceBusReceiveMode.RECEIVE_AND_DELETE,
)
async with sender, receiver:
# queue should be empty
received_msgs = await receiver.receive_messages(max_message_count=10, max_wait_time=10)
assert len(received_msgs) == 0
messages = [ServiceBusMessage("Message") for _ in range(10)]
await sender.send_messages(messages)
# wait for all messages to be sent to queue
await asyncio.sleep(10)
# receive messages + add to internal buffer should have messages now
received_msgs = await receiver.receive_messages(max_message_count=10, max_wait_time=10)
assert len(received_msgs) == 10
|
