|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import io |
| 4 | +import logging |
| 5 | + |
| 6 | +from logprivacy import LogPrivacyFilter, get_safe_logger |
| 7 | + |
| 8 | + |
| 9 | +def _restore_logger( |
| 10 | + logger: logging.Logger, |
| 11 | + *, |
| 12 | + handlers: list[logging.Handler], |
| 13 | + filters: list[logging.Filter], |
| 14 | + level: int, |
| 15 | + propagate: bool, |
| 16 | +) -> None: |
| 17 | + logger.handlers[:] = handlers |
| 18 | + logger.filters[:] = filters |
| 19 | + logger.setLevel(level) |
| 20 | + logger.propagate = propagate |
| 21 | + |
| 22 | + |
| 23 | +def test_get_safe_logger_protects_existing_child_handler_without_propagation() -> None: |
| 24 | + parent = logging.getLogger("child-handler-secure") |
| 25 | + child = logging.getLogger("child-handler-secure.worker") |
| 26 | + parent_state = { |
| 27 | + "handlers": list(parent.handlers), |
| 28 | + "filters": list(parent.filters), |
| 29 | + "level": parent.level, |
| 30 | + "propagate": parent.propagate, |
| 31 | + } |
| 32 | + child_state = { |
| 33 | + "handlers": list(child.handlers), |
| 34 | + "filters": list(child.filters), |
| 35 | + "level": child.level, |
| 36 | + "propagate": child.propagate, |
| 37 | + } |
| 38 | + stream = io.StringIO() |
| 39 | + handler = logging.StreamHandler(stream) |
| 40 | + |
| 41 | + try: |
| 42 | + parent.handlers[:] = [] |
| 43 | + parent.propagate = False |
| 44 | + child.handlers[:] = [handler] |
| 45 | + child.filters[:] = [] |
| 46 | + child.setLevel(logging.DEBUG) |
| 47 | + child.propagate = False |
| 48 | + |
| 49 | + get_safe_logger("child-handler-secure", level=logging.DEBUG) |
| 50 | + child.error("email=%s password=%s", "john@example.com", "secret123") |
| 51 | + finally: |
| 52 | + _restore_logger(parent, **parent_state) |
| 53 | + _restore_logger(child, **child_state) |
| 54 | + |
| 55 | + rendered = stream.getvalue() |
| 56 | + assert "john@example.com" not in rendered |
| 57 | + assert "secret123" not in rendered |
| 58 | + assert "email=[EMAIL] password=[SECRET]" in rendered |
| 59 | + |
| 60 | + |
| 61 | +def test_get_safe_logger_deduplicates_filters_on_existing_child_handler() -> None: |
| 62 | + parent = logging.getLogger("child-handler-deduplicated") |
| 63 | + child = logging.getLogger("child-handler-deduplicated.worker") |
| 64 | + parent_state = { |
| 65 | + "handlers": list(parent.handlers), |
| 66 | + "filters": list(parent.filters), |
| 67 | + "level": parent.level, |
| 68 | + "propagate": parent.propagate, |
| 69 | + } |
| 70 | + child_state = { |
| 71 | + "handlers": list(child.handlers), |
| 72 | + "filters": list(child.filters), |
| 73 | + "level": child.level, |
| 74 | + "propagate": child.propagate, |
| 75 | + } |
| 76 | + handler = logging.StreamHandler(io.StringIO()) |
| 77 | + |
| 78 | + try: |
| 79 | + parent.handlers[:] = [] |
| 80 | + parent.propagate = False |
| 81 | + child.handlers[:] = [handler] |
| 82 | + child.propagate = False |
| 83 | + |
| 84 | + get_safe_logger("child-handler-deduplicated") |
| 85 | + get_safe_logger("child-handler-deduplicated") |
| 86 | + |
| 87 | + scoped = [ |
| 88 | + candidate |
| 89 | + for candidate in handler.filters |
| 90 | + if isinstance(candidate, LogPrivacyFilter) |
| 91 | + and candidate.logger_prefix == "child-handler-deduplicated" |
| 92 | + ] |
| 93 | + assert len(scoped) == 1 |
| 94 | + finally: |
| 95 | + _restore_logger(parent, **parent_state) |
| 96 | + _restore_logger(child, **child_state) |
| 97 | + |
| 98 | + |
| 99 | +def test_get_safe_logger_does_not_install_filters_on_unrelated_child_handlers() -> None: |
| 100 | + parent = logging.getLogger("child-handler-scope") |
| 101 | + unrelated = logging.getLogger("other-child-handler.worker") |
| 102 | + parent_state = { |
| 103 | + "handlers": list(parent.handlers), |
| 104 | + "filters": list(parent.filters), |
| 105 | + "level": parent.level, |
| 106 | + "propagate": parent.propagate, |
| 107 | + } |
| 108 | + unrelated_state = { |
| 109 | + "handlers": list(unrelated.handlers), |
| 110 | + "filters": list(unrelated.filters), |
| 111 | + "level": unrelated.level, |
| 112 | + "propagate": unrelated.propagate, |
| 113 | + } |
| 114 | + handler = logging.StreamHandler(io.StringIO()) |
| 115 | + |
| 116 | + try: |
| 117 | + parent.handlers[:] = [] |
| 118 | + parent.propagate = False |
| 119 | + unrelated.handlers[:] = [handler] |
| 120 | + unrelated.propagate = False |
| 121 | + |
| 122 | + get_safe_logger("child-handler-scope") |
| 123 | + |
| 124 | + scoped = [ |
| 125 | + candidate for candidate in handler.filters if isinstance(candidate, LogPrivacyFilter) |
| 126 | + ] |
| 127 | + assert scoped == [] |
| 128 | + finally: |
| 129 | + _restore_logger(parent, **parent_state) |
| 130 | + _restore_logger(unrelated, **unrelated_state) |
| 131 | + |
| 132 | + |
| 133 | +def test_get_safe_logger_does_not_match_similar_namespace_prefix() -> None: |
| 134 | + parent = logging.getLogger("app") |
| 135 | + unrelated = logging.getLogger("application.worker") |
| 136 | + parent_state = { |
| 137 | + "handlers": list(parent.handlers), |
| 138 | + "filters": list(parent.filters), |
| 139 | + "level": parent.level, |
| 140 | + "propagate": parent.propagate, |
| 141 | + } |
| 142 | + unrelated_state = { |
| 143 | + "handlers": list(unrelated.handlers), |
| 144 | + "filters": list(unrelated.filters), |
| 145 | + "level": unrelated.level, |
| 146 | + "propagate": unrelated.propagate, |
| 147 | + } |
| 148 | + handler = logging.StreamHandler(io.StringIO()) |
| 149 | + |
| 150 | + try: |
| 151 | + parent.handlers[:] = [] |
| 152 | + parent.propagate = False |
| 153 | + unrelated.handlers[:] = [handler] |
| 154 | + unrelated.propagate = False |
| 155 | + |
| 156 | + get_safe_logger("app") |
| 157 | + |
| 158 | + assert not any(isinstance(candidate, LogPrivacyFilter) for candidate in handler.filters) |
| 159 | + finally: |
| 160 | + _restore_logger(parent, **parent_state) |
| 161 | + _restore_logger(unrelated, **unrelated_state) |
| 162 | + |
| 163 | + |
| 164 | +def test_shared_handler_receives_one_scoped_filter() -> None: |
| 165 | + parent = logging.getLogger("shared-handler") |
| 166 | + child = logging.getLogger("shared-handler.worker") |
| 167 | + parent_state = { |
| 168 | + "handlers": list(parent.handlers), |
| 169 | + "filters": list(parent.filters), |
| 170 | + "level": parent.level, |
| 171 | + "propagate": parent.propagate, |
| 172 | + } |
| 173 | + child_state = { |
| 174 | + "handlers": list(child.handlers), |
| 175 | + "filters": list(child.filters), |
| 176 | + "level": child.level, |
| 177 | + "propagate": child.propagate, |
| 178 | + } |
| 179 | + handler = logging.StreamHandler(io.StringIO()) |
| 180 | + |
| 181 | + try: |
| 182 | + parent.handlers[:] = [handler] |
| 183 | + parent.propagate = False |
| 184 | + child.handlers[:] = [handler] |
| 185 | + child.propagate = False |
| 186 | + |
| 187 | + get_safe_logger("shared-handler") |
| 188 | + |
| 189 | + scoped = [ |
| 190 | + candidate |
| 191 | + for candidate in handler.filters |
| 192 | + if isinstance(candidate, LogPrivacyFilter) |
| 193 | + and candidate.logger_prefix == "shared-handler" |
| 194 | + ] |
| 195 | + assert len(scoped) == 1 |
| 196 | + finally: |
| 197 | + _restore_logger(parent, **parent_state) |
| 198 | + _restore_logger(child, **child_state) |
0 commit comments