File size: 22,592 Bytes
ce676f7 | 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 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 | # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import builtins
import json
import logging
import os
import sys
from datetime import datetime, timezone
from pathlib import Path
from typing import Generator
import structlog
from test.tracing.utils import SpyingTracer
from unittest.mock import ANY
import pytest
from _pytest.capture import CaptureFixture
from _pytest.logging import LogCaptureFixture
from _pytest.monkeypatch import MonkeyPatch
import haystack.utils.jupyter
from haystack import logging as haystack_logging
@pytest.fixture(autouse=True)
def reset_logging_config() -> None:
old_handlers = logging.root.handlers.copy()
yield
# Reset the logging configuration after each test to avoid impacting other tests
logging.root.handlers = old_handlers
@pytest.fixture()
def set_context_var_key() -> Generator[str, None, None]:
structlog.contextvars.bind_contextvars(context_var="value")
yield "context_var"
structlog.contextvars.unbind_contextvars("context_var")
class TestSkipLoggingConfiguration:
def test_skip_logging_configuration(
self, monkeypatch: MonkeyPatch, capfd: CaptureFixture, caplog: LogCaptureFixture
) -> None:
monkeypatch.setenv("HAYSTACK_LOGGING_IGNORE_STRUCTLOG", "true")
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# the pytest fixture caplog only captures logs being rendered from the stdlib logging module
assert caplog.messages == ["Hello, structured logging!"]
# Nothing should be captured by capfd since structlog is not configured
assert capfd.readouterr().err == ""
class TestStructuredLoggingConsoleRendering:
def test_log_filtering_when_using_debug(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=False)
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
logger.debug("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert output == ""
def test_log_filtering_when_using_debug_and_log_level_is_debug(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=False)
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.debug("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "Hello, structured logging" in output
assert "{" not in output, "Seems JSON rendering is enabled when it should not be"
def test_console_rendered_structured_log_even_if_no_tty_but_python_config(
self, capfd: CaptureFixture, monkeypatch: MonkeyPatch
) -> None:
monkeypatch.setattr(sys.stderr, "isatty", lambda: False)
haystack_logging.configure_logging(use_json=False)
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "Hello, structured logging!" in output
assert "{" not in output, "Seems JSON rendering is enabled when it should not be"
def test_console_rendered_structured_log_if_in_ipython(
self, capfd: CaptureFixture, monkeypatch: MonkeyPatch
) -> None:
monkeypatch.setattr(builtins, "__IPYTHON__", "true", raising=False)
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "Hello, structured logging!" in output
assert "{" not in output, "Seems JSON rendering is enabled when it should not be"
def test_console_rendered_structured_log_even_in_jupyter(
self, capfd: CaptureFixture, monkeypatch: MonkeyPatch
) -> None:
monkeypatch.setattr(haystack.utils.jupyter, haystack.utils.jupyter.is_in_jupyter.__name__, lambda: True)
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "Hello, structured logging!" in output
assert "{" not in output, "Seems JSON rendering is enabled when it should not be"
def test_console_rendered_structured_log_even_if_no_tty_but_forced_through_env(
self, capfd: CaptureFixture, monkeypatch: MonkeyPatch
) -> None:
monkeypatch.setenv("HAYSTACK_LOGGING_USE_JSON", "false")
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "Hello, structured logging!" in output
assert "{" not in output, "Seems JSON rendering is enabled when it should not be"
def test_console_rendered_structured_log(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
# Only check for the minute to be a bit more robust
today = datetime.now(tz=timezone.utc).isoformat(timespec="minutes").replace("+00:00", "")
assert today in output
log_level = "warning"
assert log_level in output
assert "Hello, structured logging!" in output
assert "key1" in output
assert "value1" in output
def test_logging_exceptions(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
def function_that_raises_and_adds_to_stack_trace():
raise ValueError("This is an error")
try:
function_that_raises_and_adds_to_stack_trace()
except ValueError:
logger.exception("An error happened")
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert "An error happened" in output
def test_logging_of_contextvars(self, capfd: CaptureFixture, set_context_var_key: str) -> None:
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
assert set_context_var_key in output
class TestStructuredLoggingJSONRendering:
def test_logging_as_json_if_not_atty(self, capfd: CaptureFixture, monkeypatch: MonkeyPatch) -> None:
monkeypatch.setattr(sys.stderr, "isatty", lambda: False)
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
parsed_output = json.loads(output) # should not raise an error
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_logging_as_json(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
parsed_output = json.loads(output) # should not raise an error
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_logging_as_json_enabling_via_env(self, capfd: CaptureFixture, monkeypatch: MonkeyPatch) -> None:
monkeypatch.setenv("HAYSTACK_LOGGING_USE_JSON", "true")
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
parsed_output = json.loads(output) # should not raise an error
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_logging_of_contextvars(
self, capfd: CaptureFixture, monkeypatch: MonkeyPatch, set_context_var_key: str
) -> None:
monkeypatch.setenv("HAYSTACK_LOGGING_USE_JSON", "true")
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
parsed_output = json.loads(output) # should not raise an error
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
set_context_var_key: "value",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_logging_exceptions_json(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = logging.getLogger(__name__)
def function_that_raises_and_adds_to_stack_trace():
my_local_variable = "my_local_variable" # noqa: F841
raise ValueError("This is an error")
try:
function_that_raises_and_adds_to_stack_trace()
except ValueError:
logger.exception("An error happened ")
# Use `capfd` to capture the output of the final structlog rendering result
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "An error happened ",
"level": "error",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
"exception": [
{
"exc_type": "ValueError",
"exc_value": "This is an error",
"syntax_error": None,
"is_cause": False,
"frames": [
{
"filename": str(Path.cwd() / "test" / "test_logging.py"),
"lineno": ANY, # otherwise the test breaks if you add a line :-)
"name": "test_logging_exceptions_json",
},
{
"filename": str(Path.cwd() / "test" / "test_logging.py"),
"lineno": ANY, # otherwise the test breaks if you add a line :-)
"name": "function_that_raises_and_adds_to_stack_trace",
},
],
}
],
}
class TestLogTraceCorrelation:
def test_trace_log_correlation_python_logs_with_console_rendering(
self, spying_tracer: SpyingTracer, capfd: CaptureFixture
) -> None:
haystack_logging.configure_logging(use_json=False)
with spying_tracer.trace("test-operation"):
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
output = capfd.readouterr().err
assert "trace_id" not in output
def test_trace_log_correlation_python_logs(self, spying_tracer: SpyingTracer, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
with spying_tracer.trace("test-operation") as span:
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"trace_id": span.trace_id,
"span_id": span.span_id,
"lineno": ANY,
"module": "test.test_logging",
}
def test_trace_log_correlation_no_span(self, spying_tracer: SpyingTracer, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_trace_log_correlation_no_tracer(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "Hello, structured logging!",
"key1": "value1",
"key2": "value2",
"level": "warning",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
class TestCompositeLogger:
def test_correct_stack_level_with_stdlib_rendering(
self, monkeypatch: MonkeyPatch, capfd: CaptureFixture, caplog: LogCaptureFixture
) -> None:
monkeypatch.setenv("HAYSTACK_LOGGING_IGNORE_STRUCTLOG", "true")
haystack_logging.configure_logging()
logger = logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
# the pytest fixture caplog only captures logs being rendered from the stdlib logging module
assert caplog.messages == ["Hello, structured logging!"]
assert caplog.records[0].name == "test.test_logging"
# Nothing should be captured by capfd since structlog is not configured
assert capfd.readouterr().err == ""
def test_correct_stack_level_with_consoler_rendering(self, capfd: CaptureFixture) -> None:
haystack_logging.configure_logging(use_json=False)
logger = haystack_logging.getLogger(__name__)
logger.warning("Hello, structured logging!", extra={"key1": "value1", "key2": "value2"})
output = capfd.readouterr().err
assert "test.test_logging" in output
@pytest.mark.parametrize(
"method, expected_level",
[
("debug", "debug"),
("info", "info"),
("warning", "warning"),
("error", "error"),
("fatal", "critical"),
("exception", "error"),
("critical", "critical"),
],
)
def test_various_levels(self, capfd: LogCaptureFixture, method: str, expected_level: str) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
getattr(logger, method)("Hello, structured {key}!", key="logging", key1="value1", key2="value2")
output = capfd.readouterr().err
parsed_output = json.loads(output) # should not raise an error
assert parsed_output == {
"event": "Hello, structured logging!",
"key": "logging",
"key1": "value1",
"key2": "value2",
"level": expected_level,
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_log(self, capfd: LogCaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.log(logging.DEBUG, "Hello, structured '{key}'!", key="logging", key1="value1", key2="value2")
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "Hello, structured 'logging'!",
"key": "logging",
"key1": "value1",
"key2": "value2",
"level": "debug",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_log_json_content(self, capfd: LogCaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.log(logging.DEBUG, 'Hello, structured: {"key": "value"}', key="logging", key1="value1", key2="value2")
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": 'Hello, structured: {"key": "value"}',
"key": "logging",
"key1": "value1",
"key2": "value2",
"level": "debug",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
def test_log_with_string_cast(self, capfd: LogCaptureFixture) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.log(logging.DEBUG, "Hello, structured '{key}'!", key=LogCaptureFixture, key1="value1", key2="value2")
output = capfd.readouterr().err
parsed_output = json.loads(output)
assert parsed_output == {
"event": "Hello, structured '<class '_pytest.logging.LogCaptureFixture'>'!",
"key": "<class '_pytest.logging.LogCaptureFixture'>",
"key1": "value1",
"key2": "value2",
"level": "debug",
"timestamp": ANY,
"lineno": ANY,
"module": "test.test_logging",
}
@pytest.mark.parametrize(
"method, expected_level",
[
("debug", "debug"),
("info", "info"),
("warning", "warning"),
("error", "error"),
("fatal", "critical"),
("exception", "exception"),
("critical", "critical"),
],
)
def test_haystack_logger_with_positional_args(self, method: str, expected_level: str) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
with pytest.raises(TypeError):
getattr(logger, method)("Hello, structured logging %s!", "logging")
@pytest.mark.parametrize(
"method, expected_level",
[
("debug", "debug"),
("info", "info"),
("warning", "warning"),
("error", "error"),
("fatal", "critical"),
("exception", "exception"),
("critical", "critical"),
],
)
def test_haystack_logger_with_old_interpolation(self, method: str, expected_level: str) -> None:
haystack_logging.configure_logging(use_json=True)
logger = haystack_logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
# does not raise - hence we need to check this separately
getattr(logger, method)("Hello, structured logging %s!", key="logging")
def test_that_haystack_logger_is_used(self) -> None:
"""Forces the usage of the Haystack logger instead of the standard library logger."""
allowed_list = [Path("haystack") / "logging.py"]
for root, dirs, files in os.walk("haystack"):
for file in files:
path = Path(root) / file
if not path.suffix.endswith(".py"):
continue
if path in allowed_list:
continue
content = path.read_text(encoding="utf-8")
# that looks like somebody is using our standard logger
if " logging.getLogger" in content:
haystack_logger_in_content = " haystack import logging" in content or ", logging" in content
assert haystack_logger_in_content, (
f"{path} doesn't use the Haystack logger. Please use the Haystack logger instead of the "
f"standard library logger and add plenty of keyword arguments."
)
|