summaryrefslogtreecommitdiffstats
path: root/openbb_platform/core/tests/app/logs/test_handlers_manager.py
blob: d46451c63146675349d0d949fa0bea16c31736d3 (plain)
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
"""Tests for the handlers manager."""

import logging
from unittest.mock import Mock, patch

from openbb_core.app.logs.handlers_manager import (
    HandlersManager,
    PathTrackingFileHandler,
    PosthogHandler,
)

# pylint: disable=W0231


class MockPosthogHandler(logging.NullHandler):
    """Mock posthog handler."""

    def __init__(self, settings):
        """Initialize the handler."""
        self.settings = settings
        self.level = logging.DEBUG


class MockPathTrackingFileHandler(logging.NullHandler):
    """Mock path tracking file handler."""

    def __init__(self, settings):
        """Initialize the handler."""
        self.settings = settings
        self.level = logging.DEBUG


class MockFormatterWithExceptions(logging.Formatter):
    """Mock formatter with exceptions."""

    def __init__(self, settings):
        """Initialize the formatter."""
        self.settings = settings


def test_handlers_added_correctly():
    """Test if the handlers are added correctly."""
    with patch(
        "openbb_core.app.logs.handlers_manager.PosthogHandler",
        MockPosthogHandler,
    ), patch(
        "openbb_core.app.logs.handlers_manager.PathTrackingFileHandler",
        MockPathTrackingFileHandler,
    ), patch(
        "openbb_core.app.logs.handlers_manager.FormatterWithExceptions",
        MockFormatterWithExceptions,
    ):
        settings = Mock()
        settings.handler_list = ["stdout", "stderr", "noop", "file", "posthog"]
        _ = HandlersManager(settings=settings)

        handlers = logging.getLogger().handlers

        assert len(handlers) >= 5

        for handler in handlers:
            assert isinstance(
                handler,
                (
                    logging.NullHandler,
                    logging.StreamHandler,
                    PathTrackingFileHandler,
                    PosthogHandler,
                ),
            )

        for mock in [MockPosthogHandler, MockPathTrackingFileHandler]:
            assert any(isinstance(handler, mock) for handler in handlers)


def test_update_handlers():
    """Test if the handlers are updated correctly."""
    with patch(
        "openbb_core.app.logs.handlers_manager.PosthogHandler",
        MockPosthogHandler,
    ), patch(
        "openbb_core.app.logs.handlers_manager.PathTrackingFileHandler",
        MockPathTrackingFileHandler,
    ), patch(
        "openbb_core.app.logs.handlers_manager.FormatterWithExceptions",
        MockFormatterWithExceptions,
    ):
        settings = Mock()
        settings.handler_list = ["file", "posthog"]
        settings.any_other_attr = "mock_settings"
        handlers_manager = HandlersManager(settings=settings)

        changed_settings = Mock()
        changed_settings.any_other_attr = "changed_settings"

        handlers_manager.update_handlers(settings=changed_settings)

        handlers = logging.getLogger().handlers

        for hdlr in handlers:
            if isinstance(hdlr, (MockPosthogHandler, MockPathTrackingFileHandler)):
                assert hdlr.settings == changed_settings
                assert hdlr.formatter.settings == changed_settings  # type: ignore[union-attr]