File: stress_test_queues_async.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (549 lines) | stat: -rw-r--r-- 21,062 bytes parent folder | download
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
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------

from datetime import timedelta
import logging
import time
import os
import asyncio
from dotenv import load_dotenv
from argparse import ArgumentParser

from azure.servicebus import AutoLockRenewer, TransportType
from azure.servicebus.aio import ServiceBusClient
from azure.servicebus.aio.management import ServiceBusAdministrationClient
from azure.servicebus._common.constants import ServiceBusReceiveMode
from app_insights_metric import AzureMonitorMetric
from azure.identity.aio import DefaultAzureCredential

from stress_test_base import StressTestRunnerAsync, ReceiveType

ENV_FILE = os.environ.get("ENV_FILE")

credential = DefaultAzureCredential()


async def test_stress_queue_send_and_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_send_and_pull_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        receive_type=ReceiveType.pull,
        duration=args.duration,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_send_and_pull_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_batch_send_and_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, prefetch_count=5, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        send_batch_size=5,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_batch_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_slow_send_and_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        send_delay=(args.duration / 3),
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_slow_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_receive_and_delete(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[
            sb_client.get_queue_receiver(
                SERVICEBUS_QUEUE_NAME,
                receive_mode=ServiceBusReceiveMode.RECEIVE_AND_DELETE,
                max_wait_time=10,
            )
        ],
        admin_client=sb_admin_client,
        should_complete_messages=False,
        duration=args.duration,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_slow_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_unsettled_messages(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        should_complete_messages=False,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_unsettled_messages"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    # This test is prompted by reports of an issue where enough unsettled messages saturate a service-side cache
    # and prevent further receipt.
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def test_stress_queue_receive_large_batch_size(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = StressTestRunnerAsync(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, prefetch_count=50, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        max_message_count=50,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_receive_large_batch_size"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


# Cannot be async defined at local scope due to pickling into multiproc runner.
class ReceiverTimeoutStressTestRunner(StressTestRunnerAsync):
    def on_send(self, state, sent_message, sender):
        """Called on every successful send"""
        if state.total_sent % 10 == 0:
            # To make receive time out, in push mode this delay would trigger receiver reconnection
            time.sleep(self.max_wait_time + 5)


async def test_stress_queue_pull_receive_timeout(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = ReceiverTimeoutStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        max_wait_time=5,
        receive_type=ReceiveType.pull,
        duration=args.duration,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_pull_receive_timeout"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


class LongRenewStressTestRunner(StressTestRunnerAsync):
    def on_receive(self, state, received_message, receiver):
        """Called on every successful receive"""
        renewer = AutoLockRenewer()
        renewer.register(receiver, received_message, max_lock_renewal_duration=300)
        time.sleep(300)


async def test_stress_queue_long_renew_send_and_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = LongRenewStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        send_delay=300,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_long_renew_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


class LongSessionRenewStressTestRunner(StressTestRunnerAsync):
    def on_receive(self, state, received_message, receiver):
        """Called on every successful receive"""
        renewer = AutoLockRenewer()

        def on_fail(renewable, error):
            print("FAILED AUTOLOCKRENEW: " + str(error))

        renewer.register(
            receiver,
            receiver.session,
            max_lock_renewal_duration=600,
            on_lock_renew_failure=on_fail,
        )


async def test_stress_queue_long_renew_session_send_and_receive(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    session_id = "test_stress_queue_long_renew_send_and_receive"

    stress_test = LongSessionRenewStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, session_id=session_id, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        send_delay=300,
        send_session_id=session_id,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_long_renew_session_send_and_receive"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


class Peekon_receiveStressTestRunner(StressTestRunnerAsync):
    def on_receive_batch(self, state, received_message, receiver):
        """Called on every successful receive"""
        assert receiver.peek_messages()[0]


async def test_stress_queue_peek_messages(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = Peekon_receiveStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        receive_delay=30,
        receive_type=ReceiveType.none,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_peek_messages"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")
    # TODO: This merits better validation, to be implemented alongside full metric spread.


class RestartHandlerStressTestRunner(StressTestRunnerAsync):
    def post_receive(self, state, receiver):
        """Called after completion of every successful receive"""
        if state.total_received % 3 == 0:
            receiver.__exit__()
            receiver.__enter__()

    def on_send(self, state, sent_message, sender):
        """Called after completion of every successful receive"""
        if state.total_sent % 3 == 0:
            sender.__exit__()
            sender.__enter__()


async def test_stress_queue_close_and_reopen(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = RestartHandlerStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        duration=args.duration,
        receive_delay=30,
        send_delay=10,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_close_and_reopen"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


# This test validates that all individual messages are received contiguously over a long time period.
# (e.g. not dropped for whatever reason, not sent, or not received)
class DroppedMessageCheckerStressTestRunner(StressTestRunnerAsync):
    def on_receive(self, state, received_message, receiver):
        """Called on every successful receive"""
        last_seen = getattr(state, "last_seen", -1)
        noncontiguous = getattr(state, "noncontiguous", set())
        body = int(str(received_message))
        if body == last_seen + 1:
            last_seen += 1
            if noncontiguous:
                while (last_seen + 1) in noncontiguous:
                    last_seen += 1
                    noncontiguous.remove(last_seen)
        else:
            noncontiguous.add(body)
        state.noncontiguous = noncontiguous
        state.last_seen = last_seen

    def pre_process_message_body(self, payload):
        """Called when constructing message body"""
        try:
            body = self._message_id
        except:
            _message_id = 0
            body = 0
        _message_id += 1

        return str(body)


async def test_stress_queue_check_for_dropped_messages(args):
    sb_client = ServiceBusClient(
        HOSTNAME,
        credential,
        logging_enable=LOGGING_ENABLE,
        transport_type=TRANSPORT_TYPE,
        uamqp_transport=UAMQP_TRANSPORT,
    )
    stress_test = DroppedMessageCheckerStressTestRunner(
        senders=[sb_client.get_queue_sender(SERVICEBUS_QUEUE_NAME)],
        receivers=[sb_client.get_queue_receiver(SERVICEBUS_QUEUE_NAME, max_wait_time=10)],
        admin_client=sb_admin_client,
        receive_type=ReceiveType.pull,
        duration=args.duration,
        azure_monitor_metric=AzureMonitorMetric("test_stress_queue_check_for_dropped_messages"),
        logging_level=LOGGING_LEVEL,
        transport_type=args.transport,
        rotating_logs=args.rotating_logs,
    )

    result = await stress_test.run_async()
    print(f"Total send {result.total_sent}")
    print(f"Total received {result.total_received}")


async def run(args):
    if args.method == "send_receive":
        await test_stress_queue_send_and_receive(args)
    elif args.method == "send_pull_receive":
        await test_stress_queue_send_and_pull_receive(args)
    elif args.method == "send_receive_batch":
        await test_stress_queue_batch_send_and_receive(args)
    elif args.method == "send_receive_slow":
        await test_stress_queue_slow_send_and_receive(args)
    elif args.method == "receive_delete":
        await test_stress_queue_receive_and_delete(args)
    elif args.method == "unsettled_message":
        await test_stress_queue_unsettled_messages(args)
    elif args.method == "large_batch":
        await test_stress_queue_receive_large_batch_size(args)
    elif args.method == "pull_receive_timeout":
        await test_stress_queue_pull_receive_timeout(args)
    elif args.method == "long_renew":
        await test_stress_queue_long_renew_send_and_receive(args)
    elif args.method == "long_renew_session":
        await test_stress_queue_long_renew_session_send_and_receive(args)
    elif args.method == "queue_peek":
        await test_stress_queue_peek_messages(args)
    elif args.method == "queue_close_reopen":
        await test_stress_queue_close_and_reopen(args)
    elif args.method == "dropped_messages":
        await test_stress_queue_check_for_dropped_messages(args)
    else:
        await test_stress_queue_send_and_receive(args)
        await test_stress_queue_send_and_pull_receive(args)
        await test_stress_queue_batch_send_and_receive(args)
        await test_stress_queue_slow_send_and_receive(args)
        await test_stress_queue_receive_and_delete(args)
        await test_stress_queue_unsettled_messages(args)
        await test_stress_queue_receive_large_batch_size(args)
        await test_stress_queue_pull_receive_timeout(args)
        await test_stress_queue_long_renew_send_and_receive(args)
        await test_stress_queue_long_renew_session_send_and_receive(args)
        await test_stress_queue_peek_messages(args)
        await test_stress_queue_close_and_reopen(args)
        await test_stress_queue_check_for_dropped_messages(args)


if __name__ == "__main__":
    load_dotenv(dotenv_path=ENV_FILE, override=True)
    parser = ArgumentParser()
    parser.add_argument(
        "--conn_str",
        help="ServiceBus connection string",
        default=os.environ.get("SERVICEBUS_CONNECTION_STRING"),
    )
    parser.add_argument(
        "--hostname",
        help="ServiceBus hostname",
        default=os.environ.get("SERVICE_BUS_FULLY_QUALIFIED_NAMESPACE"),
    )
    parser.add_argument("--queue_name", help="The queue name.", default="testQueue")
    parser.add_argument("--method", type=str)
    parser.add_argument("--duration", type=int, default=259200)
    parser.add_argument("--logging-enable", action="store_true")
    parser.add_argument("--print_console", action="store_true")

    parser.add_argument("--send-batch-size", type=int, default=100)
    parser.add_argument("--message-size", type=int, default=100)

    parser.add_argument("--receive-type", type=str, default="pull")
    parser.add_argument("--max_wait_time", type=int, default=10)
    parser.add_argument("--max_message_count", type=int, default=1)
    parser.add_argument("--uamqp_mode", action="store_true")
    parser.add_argument("--transport", action="store_true")
    parser.add_argument(
        "--debug_level",
        help="Flag for setting a debug level, can be Info, Debug, Warning, Error or Critical",
        type=str,
        default="Error",
    )
    # rotate logs by default, if you want to disable it, use --no-rotating-logs flag
    parser.add_argument("--no-rotating-logs", action="store_true")

    args, _ = parser.parse_known_args()
    # store rotating_logs in args for later use
    args.rotating_logs = not args.no_rotating_logs

    if args.transport:
        TRANSPORT_TYPE = TransportType.AmqpOverWebsocket
    else:
        TRANSPORT_TYPE = TransportType.Amqp

    SERVICE_BUS_CONNECTION_STR = args.conn_str
    SERVICEBUS_QUEUE_NAME = args.queue_name
    LOGGING_ENABLE = args.logging_enable
    LOGGING_LEVEL = getattr(logging, args.debug_level.upper(), None)
    UAMQP_TRANSPORT = args.uamqp_mode
    HOSTNAME = args.hostname

    sb_admin_client = ServiceBusAdministrationClient(HOSTNAME, credential)
    loop = asyncio.get_event_loop()
    loop.run_until_complete(run(args))