File: test_queues.py

package info (click to toggle)
logbook 1.7.0-1.0
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,140 kB
  • sloc: python: 6,558; makefile: 141
file content (400 lines) | stat: -rw-r--r-- 11,321 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
import os
import socket
import time

import pytest

import logbook

from .utils import LETTERS, missing, require_module

REDIS_HOST = os.environ.get("REDIS_HOST", "localhost")
REDIS_PORT = int(os.environ.get("REDIS_PORT", "6379"))


@require_module("zmq")
def test_zeromq_handler(logger, handlers, subscriber):
    tests = [
        "Logging something",
        "Something with umlauts äöü",
        "Something else for good measure",
    ]
    for test in tests:
        for handler in handlers:
            with handler:
                logger.warn(test)
                record = subscriber.recv()
                assert record.message == test
                assert record.channel == logger.name


@require_module("zmq")
def test_zeromq_background_thread(logger, handlers, subscriber):
    test_handler = logbook.TestHandler()
    controller = subscriber.dispatch_in_background(test_handler)

    for handler in handlers:
        with handler:
            logger.warn("This is a warning")
            logger.error("This is an error")

    # stop the controller.  This will also stop the loop and join the
    # background process.  Before that we give it a fraction of a second
    # to get all results
    time.sleep(0.5)
    controller.stop()

    assert test_handler.has_warning("This is a warning")
    assert test_handler.has_error("This is an error")


@missing("zmq")
def test_missing_zeromq():
    from logbook.queues import ZeroMQHandler, ZeroMQSubscriber

    with pytest.raises(RuntimeError):
        ZeroMQHandler("tcp://127.0.0.1:42000")
    with pytest.raises(RuntimeError):
        ZeroMQSubscriber("tcp://127.0.0.1:42000")


class MultiProcessingHandlerSendBack:
    def __init__(self, queue):
        self.queue = queue

    def __call__(self):
        from logbook.queues import MultiProcessingHandler

        handler = MultiProcessingHandler(self.queue)
        handler.push_thread()
        try:
            logbook.warn("Hello World")
        finally:
            handler.pop_thread()


@require_module("multiprocessing")
def test_multi_processing_handler():
    if os.getenv("APPVEYOR") == "True":
        pytest.skip("Test hangs on AppVeyor CI")
    from multiprocessing import Process, Queue

    from logbook.queues import MultiProcessingSubscriber

    queue = Queue(-1)
    test_handler = logbook.TestHandler()
    subscriber = MultiProcessingSubscriber(queue)

    p = Process(target=MultiProcessingHandlerSendBack(queue))
    p.start()
    p.join()

    with test_handler:
        subscriber.dispatch_once()
        assert test_handler.has_warning("Hello World")


class BatchTestHandler(logbook.TestHandler):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.batches = []

    def emit(self, record):
        super().emit(record)
        self.batches.append([record])

    def emit_batch(self, records, reason):
        for record in records:
            super().emit(record)
        self.batches.append(records)


def test_threaded_wrapper_handler(logger):
    from logbook.queues import ThreadedWrapperHandler

    test_handler = BatchTestHandler()
    with ThreadedWrapperHandler(test_handler) as handler:
        logger.warn("Just testing")
        logger.error("More testing")

    # give it some time to sync up
    handler.close()

    assert not handler.controller.running
    assert len(test_handler.records) == 2
    assert len(test_handler.batches) == 2
    assert all(len(records) == 1 for records in test_handler.batches)
    assert test_handler.has_warning("Just testing")
    assert test_handler.has_error("More testing")


def test_threaded_wrapper_handler_emit():
    from logbook.queues import ThreadedWrapperHandler

    test_handler = BatchTestHandler()
    with ThreadedWrapperHandler(test_handler) as handler:
        lr = logbook.LogRecord("Test Logger", logbook.WARNING, "Just testing")
        test_handler.emit(lr)
        lr = logbook.LogRecord("Test Logger", logbook.ERROR, "More testing")
        test_handler.emit(lr)

    # give it some time to sync up
    handler.close()

    assert not handler.controller.running
    assert len(test_handler.records) == 2
    assert len(test_handler.batches) == 2
    assert all(len(records) == 1 for records in test_handler.batches)
    assert test_handler.has_warning("Just testing")
    assert test_handler.has_error("More testing")


def test_threaded_wrapper_handler_emit_batched():
    from logbook.queues import ThreadedWrapperHandler

    test_handler = BatchTestHandler()
    with ThreadedWrapperHandler(test_handler) as handler:
        test_handler.emit_batch(
            [
                logbook.LogRecord("Test Logger", logbook.WARNING, "Just testing"),
                logbook.LogRecord("Test Logger", logbook.ERROR, "More testing"),
            ],
            "group",
        )

    # give it some time to sync up
    handler.close()

    assert not handler.controller.running
    assert len(test_handler.records) == 2
    assert len(test_handler.batches) == 1
    (records,) = test_handler.batches
    assert len(records) == 2
    assert test_handler.has_warning("Just testing")
    assert test_handler.has_error("More testing")


@require_module("execnet")
def test_execnet_handler():
    def run_on_remote(channel):
        import logbook
        from logbook.queues import ExecnetChannelHandler

        handler = ExecnetChannelHandler(channel)
        log = logbook.Logger("Execnet")
        handler.push_application()
        log.info("Execnet works")

    import execnet

    gw = execnet.makegateway()
    channel = gw.remote_exec(run_on_remote)
    from logbook.queues import ExecnetChannelSubscriber

    subscriber = ExecnetChannelSubscriber(channel)
    record = subscriber.recv()
    assert record.msg == "Execnet works"
    gw.exit()


class SubscriberGroupSendBack:
    def __init__(self, message, queue):
        self.message = message
        self.queue = queue

    def __call__(self):
        from logbook.queues import MultiProcessingHandler

        with MultiProcessingHandler(self.queue):
            logbook.warn(self.message)


@require_module("multiprocessing")
def test_subscriber_group():
    if os.getenv("APPVEYOR") == "True":
        pytest.skip("Test hangs on AppVeyor CI")
    from multiprocessing import Process, Queue

    from logbook.queues import MultiProcessingSubscriber, SubscriberGroup

    a_queue = Queue(-1)
    b_queue = Queue(-1)
    subscriber = SubscriberGroup(
        [MultiProcessingSubscriber(a_queue), MultiProcessingSubscriber(b_queue)]
    )

    for _ in range(10):
        p1 = Process(target=SubscriberGroupSendBack("foo", a_queue))
        p2 = Process(target=SubscriberGroupSendBack("bar", b_queue))
        p1.start()
        p2.start()
        p1.join()
        p2.join()
        messages = [subscriber.recv().message for i in (1, 2)]
        assert sorted(messages) == ["bar", "foo"]


@require_module("redis")
def test_redis_handler():
    import redis

    from logbook.queues import RedisHandler

    KEY = f"redis-{os.getpid()}"
    FIELDS = ["message", "host"]
    r = redis.Redis(REDIS_HOST, REDIS_PORT, decode_responses=True)
    redis_handler = RedisHandler(key=KEY, level=logbook.INFO, bubble=True)
    # We don't want output for the tests, so we can wrap everything in a
    # NullHandler
    null_handler = logbook.NullHandler()

    # Check default values
    with null_handler.applicationbound():
        with redis_handler:
            logbook.info(LETTERS)

    key, message = r.blpop(KEY)
    # Are all the fields in the record?
    for field in FIELDS:
        assert message.find(field)
    assert key == KEY
    assert message.find(LETTERS)

    # Change the key of the handler and check on redis
    KEY = f"test_another_key-{os.getpid()}"
    redis_handler.key = KEY

    with null_handler.applicationbound():
        with redis_handler:
            logbook.info(LETTERS)

    key, message = r.blpop(KEY)
    assert key == KEY

    # Check that extra fields are added if specified when creating the handler
    FIELDS.append("type")
    extra_fields = {"type": "test"}
    del redis_handler
    redis_handler = RedisHandler(
        key=KEY, level=logbook.INFO, extra_fields=extra_fields, bubble=True
    )

    with null_handler.applicationbound():
        with redis_handler:
            logbook.info(LETTERS)

    key, message = r.blpop(KEY)
    for field in FIELDS:
        assert message.find(field)
    assert message.find("test")

    # And finally, check that fields are correctly added if appended to the
    # log message
    FIELDS.append("more_info")
    with null_handler.applicationbound():
        with redis_handler:
            logbook.info(LETTERS, more_info="This works")

    key, message = r.blpop(KEY)
    for field in FIELDS:
        assert message.find(field)
    assert message.find("This works")


@require_module("redis")
def test_redis_handler_lpush():
    """
    Test if lpush stores messages in the right order
    new items should be first on list
    """
    import redis

    from logbook.queues import RedisHandler

    null_handler = logbook.NullHandler()

    KEY = f"lpushed-"
    redis_handler = RedisHandler(
        key=KEY, push_method="lpush", level=logbook.INFO, bubble=True
    )

    with null_handler.applicationbound():
        with redis_handler:
            logbook.info("old item")
            logbook.info("new item")

    time.sleep(1.5)

    r = redis.Redis(REDIS_HOST, REDIS_PORT, decode_responses=True)
    logs = r.lrange(KEY, 0, -1)
    assert logs
    assert "new item" in logs[0]
    r.delete(KEY)


@require_module("redis")
def test_redis_handler_rpush():
    """
    Test if rpush stores messages in the right order
    old items should be first on list
    """
    import redis

    from logbook.queues import RedisHandler

    null_handler = logbook.NullHandler()

    KEY = "rpushed-" + str(os.getpid())
    redis_handler = RedisHandler(
        key=KEY, push_method="rpush", level=logbook.INFO, bubble=True
    )

    with null_handler.applicationbound():
        with redis_handler:
            logbook.info("old item")
            logbook.info("new item")

    time.sleep(1.5)

    r = redis.Redis(REDIS_HOST, REDIS_PORT, decode_responses=True)
    logs = r.lrange(KEY, 0, -1)
    assert logs
    assert "old item" in logs[0]
    r.delete(KEY)


@pytest.fixture
def handlers(handlers_subscriber):
    return handlers_subscriber[0]


@pytest.fixture
def subscriber(handlers_subscriber):
    return handlers_subscriber[1]


@pytest.fixture
def handlers_subscriber(multi):
    from logbook.queues import ZeroMQHandler, ZeroMQSubscriber

    # Get an unused port
    tempsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    tempsock.bind(("127.0.0.1", 0))
    host, unused_port = tempsock.getsockname()
    tempsock.close()

    # Retrieve the ZeroMQ handler and subscriber
    uri = "tcp://%s:%d" % (host, unused_port)
    if multi:
        handlers = [ZeroMQHandler(uri, multi=True) for _ in range(3)]
    else:
        handlers = [ZeroMQHandler(uri)]
    subscriber = ZeroMQSubscriber(uri, multi=multi)
    # Enough time to start
    time.sleep(0.1)
    return handlers, subscriber


@pytest.fixture(params=[True, False], ids=["multi", "nomulti"])
def multi(request):
    return request.param