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 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
|
"""Unit tests for the tiered_debug._base module.
Tests the `TieredDebug` class, which provides tiered debug logging at
levels 1-5 with configurable stack levels for caller reporting. Covers
initialization, level and stacklevel properties, logger configuration,
logging behavior, and parameters (`exc_info`, `stack_info`, `stacklevel`,
`extra`). Designed for use in projects like ElasticKeeper and
ElasticCheckpoint.
Examples:
>>> from tiered_debug._base import TieredDebug
>>> import logging
>>> debug = TieredDebug(level=2)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler, logging.Formatter("%(message)s"))
>>> debug.lv1("Test message: %s", "value") # Logs at level 1
>>> debug.lv3("Not logged") # Ignored (level 3 > 2)
"""
# pylint: disable=W0212,W0621
import logging
import sys
import platform
import pytest
from tiered_debug._base import DEFAULTS, TieredDebug
BASENAME = "tiered_debug._base"
"""Module name for debug.logger"""
@pytest.fixture
def debug():
"""Create a fresh TieredDebug instance for each test.
Returns:
TieredDebug: Instance with default settings.
Examples:
>>> debug = TieredDebug()
>>> isinstance(debug, TieredDebug)
True
"""
return TieredDebug()
# Tests for initialization
def test_default_initialization(debug):
"""Test default initialization values.
Verifies that a new TieredDebug instance uses default debug and stack
levels.
Examples:
>>> debug = TieredDebug()
>>> debug.level
1
>>> debug.stacklevel
3
"""
assert debug.level == DEFAULTS["debug"]
assert debug.stacklevel == DEFAULTS["stack"]
assert debug.logger.name == BASENAME
def test_custom_initialization():
"""Test initialization with custom values.
Verifies that custom level, stacklevel, and logger_name are set
correctly.
Examples:
>>> debug = TieredDebug(level=3, stacklevel=4, logger_name="custom")
>>> debug.level
3
>>> debug.stacklevel
4
>>> debug.logger.name
'custom'
"""
instance = TieredDebug(level=3, stacklevel=4, logger_name="custom")
assert instance.level == 3
assert instance.stacklevel == 4
assert instance.logger.name == "custom"
# Tests for level property and setter
def test_level_property(debug):
"""Test that level property returns the current level.
Examples:
>>> debug = TieredDebug()
>>> debug._level = 3
>>> debug.level
3
"""
debug._level = 3
assert debug.level == 3
def test_level_setter_valid(debug):
"""Test that level setter sets level correctly for valid inputs.
Examples:
>>> debug = TieredDebug()
>>> debug.level = 3
>>> debug.level
3
"""
debug.level = 1
assert debug._level == 1
debug.level = 3
assert debug._level == 3
debug.level = 5
assert debug._level == 5
def test_level_setter_invalid(debug, caplog):
"""Test that level setter handles invalid inputs correctly.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> debug.level = 0 # Logs warning, uses default
>>> debug.level
1
"""
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
debug.level = 0
assert "Invalid debug level: 0" in caplog.text
assert debug.level == DEFAULTS["debug"]
caplog.clear()
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
debug.level = 6
assert "Invalid debug level: 6" in caplog.text
assert debug.level == DEFAULTS["debug"]
# Tests for stacklevel property and setter
def test_stacklevel_property(debug):
"""Test that stacklevel property returns the current stacklevel.
Examples:
>>> debug = TieredDebug()
>>> debug._stacklevel = 3
>>> debug.stacklevel
3
"""
debug._stacklevel = 3
assert debug.stacklevel == 3
def test_stacklevel_setter_valid(debug):
"""Test that stacklevel setter sets stacklevel correctly for valid inputs.
Examples:
>>> debug = TieredDebug()
>>> debug.stacklevel = 3
>>> debug.stacklevel
3
"""
debug.stacklevel = 1
assert debug._stacklevel == 1
debug.stacklevel = 3
assert debug._stacklevel == 3
debug.stacklevel = 9
assert debug._stacklevel == 9
def test_stacklevel_setter_invalid(debug, caplog):
"""Test that stacklevel setter handles invalid inputs correctly.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> debug.stacklevel = 0 # Logs warning, uses default
>>> debug.stacklevel
3
"""
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
debug.stacklevel = 0
assert "Invalid stack level: 0" in caplog.text
assert debug.stacklevel == DEFAULTS["stack"]
caplog.clear()
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
debug.stacklevel = 10
assert "Invalid stack level: 10" in caplog.text
assert debug.stacklevel == DEFAULTS["stack"]
# Tests for logger property
def test_logger_property(debug):
"""Test that logger property returns the instance-level logger.
Examples:
>>> debug = TieredDebug()
>>> isinstance(debug.logger, logging.Logger)
True
"""
assert isinstance(debug.logger, logging.Logger)
assert debug.logger.name == BASENAME
def test_logger_custom_name():
"""Test that logger property reflects custom logger name.
Examples:
>>> debug = TieredDebug(logger_name="test.logger")
>>> debug.logger.name
'test.logger'
"""
debug = TieredDebug(logger_name="test.logger")
assert debug.logger.name == "test.logger"
# Tests for add_handler method
def test_add_handler(debug, caplog):
"""Test that add_handler adds a handler and logs correctly.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> handler in debug.logger.handlers
True
"""
caplog.set_level(logging.DEBUG)
handler = logging.StreamHandler()
formatter = logging.Formatter("%(funcName)s:%(lineno)d %(message)s")
debug.add_handler(handler, formatter=formatter)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("Test message")
assert "DEBUG1 Test message" in caplog.text
assert handler in debug.logger.handlers
def test_add_handler_duplicate(debug, caplog):
"""Test that add_handler skips duplicate handlers with an info message.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.add_handler(handler) # Logs info, skips
"""
caplog.set_level(logging.DEBUG)
handler = logging.StreamHandler()
debug.add_handler(handler)
post_add = len(debug.logger.handlers)
with caplog.at_level(logging.INFO, logger=debug.logger.name):
debug.add_handler(handler)
assert "Handler already attached to logger, skipping" in caplog.text
assert len(debug.logger.handlers) == post_add # No duplicate added
# Tests for check_val method
def test_check_val_valid(debug):
"""Test that check_val returns valid values unchanged.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug()
>>> debug.check_val(3, "debug")
3
"""
assert debug.check_val(3, "debug") == 3
assert debug.check_val(5, "debug") == 5
assert debug.check_val(3, "stack") == 3
assert debug.check_val(9, "stack") == 9
def test_check_val_invalid(debug, caplog):
"""Test that check_val returns default values for invalid inputs.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> debug.check_val(0, "debug") # Logs warning
1
"""
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
assert debug.check_val(0, "debug") == DEFAULTS["debug"]
assert "Invalid debug level: 0" in caplog.text
caplog.clear()
with caplog.at_level(logging.WARNING, logger=debug.logger.name):
assert debug.check_val(10, "stack") == DEFAULTS["stack"]
assert "Invalid stack level: 10" in caplog.text
def test_check_val_invalid_kind(debug):
"""Test that check_val raises ValueError for invalid kind.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug()
>>> try:
... debug.check_val(3, "invalid")
... except ValueError as e:
... print(str(e))
Invalid kind: invalid. Must be 'debug' or 'stack'
"""
with pytest.raises(ValueError, match="Invalid kind: invalid"):
debug.check_val(3, "invalid")
# Tests for _select_frame_getter and _get_logger_name
def test_get_logger_name_valid(debug):
"""Test that _get_logger_name returns correct module name.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug()
>>> debug._get_logger_name(1)
'__main__'
"""
name = debug._get_logger_name(1)
assert name == __name__
def test_get_logger_name_invalid_stack(debug):
"""Test that _get_logger_name handles invalid stack levels.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug()
>>> debug._get_logger_name(100)
'unknown'
"""
name = debug._get_logger_name(100) # Too deep
assert name == "unknown"
def test_select_frame_getter_cpython(debug, monkeypatch):
"""Test that _select_frame_getter uses sys._getframe in CPython.
Args:
debug: TieredDebug instance. (TieredDebug)
monkeypatch: Pytest monkeypatch fixture.
Examples:
>>> debug = TieredDebug()
>>> import platform
>>> if platform.python_implementation() == "CPython":
... assert debug._select_frame_getter() is sys._getframe
"""
monkeypatch.setattr(platform, "python_implementation", lambda: "CPython")
getter = debug._select_frame_getter()
assert getter is sys._getframe
def test_select_frame_getter_non_cpython(debug, monkeypatch):
"""Test that _select_frame_getter uses inspect.currentframe in non-CPython.
Args:
debug: TieredDebug instance. (TieredDebug)
monkeypatch: Pytest monkeypatch fixture.
Examples:
>>> debug = TieredDebug()
>>> import platform
>>> import inspect
>>> if platform.python_implementation() != "CPython":
... frame = debug._select_frame_getter()()
... assert frame is not None
"""
monkeypatch.setattr(platform, "python_implementation", lambda: "PyPy")
getter = debug._select_frame_getter()
frame = getter()
assert frame is not None # Returns a frame object
assert frame.f_back is not None # Can access parent frame
# Tests for change_level context manager
def test_change_level(debug):
"""Test that change_level temporarily changes the level.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug(level=2)
>>> with debug.change_level(4):
... assert debug.level == 4
>>> debug.level
2
"""
debug.level = 2
assert debug.level == 2
with debug.change_level(4):
assert debug.level == 4
assert debug.level == 2 # Restored
def test_change_level_with_exception(debug):
"""Test that change_level restores level despite exceptions.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug(level=2)
>>> try:
... with debug.change_level(4):
... raise RuntimeError
... except RuntimeError:
... pass
>>> debug.level
2
"""
debug.level = 2
try:
with debug.change_level(4):
assert debug.level == 4
raise RuntimeError("Test exception")
except RuntimeError:
pass
assert debug.level == 2 # Restored
# Tests for log method
def test_log_valid_level(debug, caplog):
"""Test that log method logs messages at valid levels with args.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=3)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.log(2, "Test: %s", "value")
"""
caplog.set_level(logging.DEBUG)
debug.level = 3
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.log(2, "Test message: %s", "value", stacklevel=1)
assert "DEBUG2 Test message: value" in caplog.text
def test_log_invalid_level(debug):
"""Test that log method raises ValueError for invalid levels.
Args:
debug: TieredDebug instance. (TieredDebug)
Examples:
>>> debug = TieredDebug()
>>> try:
... debug.log(6, "Invalid")
... except ValueError as e:
... print(str(e))
Debug level must be 1-5
"""
with pytest.raises(ValueError, match="Debug level must be 1-5"):
debug.log(6, "Invalid level")
def test_log_with_default_stacklevel(debug, caplog):
"""Test that log uses default stacklevel if none provided.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.log(1, "Test: %s", "value")
"""
caplog.set_level(logging.DEBUG)
debug.stacklevel = 3
expected = debug._get_logger_name(2)
# So why does expected look for level 2? Because the logger name is determined
# by the frame at the stack level from which it was called. This is confusing
# because log() itself calls _get_logger_name. However, when _get_logger_name
# is called by log(), an extra level of indirection is added because it is
# being called from inside log(). In other words, in order to get the correct
# caller, it has to go up one more level than if calling _get_logger_name
# from outside of log(). When debug._get_logger_name is called directly from
# this function, it points to the caller of debug._get_logger_name, which is
# the same as the caller of log(), which is why we call it with 2 here.
# Perhaps seeing it laid out will help:
# logger=debug.logger.name here is tests.test_base, this module.
# (this function) -> log() -> _get_logger_name() = 3
# (this function) -> _get_logger_name() = 2
# Calling _get_logger_name() only needs to go up 2 levels to get the same name
# as when log() is called by this function.
# Make sense? I hope so.
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.log(1, "Test message: %s", "value")
# The name should match the logger name up two levels.
assert caplog.records[0].name == expected
def test_log_with_custom_stacklevel(debug, caplog):
"""Test that log uses provided stacklevel.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug()
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.log(1, "Test: %s", "value", stacklevel=4)
"""
caplog.set_level(logging.DEBUG)
expected = "pluggy._callers"
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.log(1, "Test message: %s", "value", stacklevel=4)
assert (
caplog.records[0].name == expected
) # In testing, stacklevel 4 points to "pluggy._callers"
# Tests for logging functions
@pytest.mark.parametrize(
"debug_level,log_level,should_log",
[
(1, 1, True), # lv1 always logs
(1, 2, False), # lv2 shouldn't log at debug level 1
(1, 3, False), # lv3 shouldn't log at debug level 1
(3, 1, True), # lv1 always logs
(3, 2, True), # lv2 should log at debug level 3
(3, 3, True), # lv3 should log at debug level 3
(3, 4, False), # lv4 shouldn't log at debug level 3
(5, 1, True), # lv1 always logs
(5, 5, True), # lv5 should log at debug level 5
],
)
def test_log_levels(debug, caplog, debug_level, log_level, should_log):
"""Test that log functions respect the current debug level.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
debug_level: Debug level to set (1-5). (int)
log_level: Log level to test (1-5). (int)
should_log: Whether the message should be logged. (bool)
Examples:
>>> debug = TieredDebug(level=3)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv2("Test: %s", "value") # Should log
>>> debug.lv4("Test") # Should not log
"""
caplog.set_level(logging.DEBUG)
debug.level = debug_level
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
log_methods = {
1: debug.lv1,
2: debug.lv2,
3: debug.lv3,
4: debug.lv4,
5: debug.lv5,
}
expected = debug._get_logger_name(1)
# So why does expected look for level 1 here?
# It looks for 2 in test_log_with_default_stacklevel, so why 1 here?
# Because it's parametrized and called from within a loop, so the stack level
# is different. When log() is called from within lvX(), it adds an extra
# level of indirection, so to get the caller of lvX(), we have to go up one
# more level than when calling log() directly. When debug._get_logger_name is
# called directly from this function, it points to the caller of
# debug._get_logger_name, which is this function.
# The caller of log() is lvX(), and the caller of lvX() is this function.
# Therefore, we need to go up one level to get the same name as
# when log() is called by lvX(), which is why we call it with 1 here.
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
log_methods[log_level](f"Test message level {log_level}: %s", "value")
msg = f"DEBUG{log_level} Test message level {log_level}: value"
assert (msg in caplog.text) == should_log
if should_log:
# Should match the logger name assigned in the fixture
assert caplog.records[0].name == expected
def test_lv1_logs_unconditionally(debug, caplog):
"""Test that lv1 logs messages without checking debug level.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value")
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("Unconditional message: %s", "value")
debug.lv2("Conditional message")
assert "DEBUG1 Unconditional message: value" in caplog.text
assert "DEBUG2 Conditional message" not in caplog.text
# Tests for exc_info, stack_info, and extra parameters
def test_log_with_exc_info(debug, caplog):
"""Test that log method includes exception info when exc_info=True.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> try:
... raise ValueError("Test")
... except ValueError:
... debug.lv1("Error: %s", "info", exc_info=True)
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
try:
raise ValueError("Test error")
except ValueError:
debug.lv1("Error occurred: %s", "info", exc_info=True)
assert "DEBUG1 Error occurred: info" in caplog.text
assert "ValueError: Test error" in caplog.text
def test_log_without_exc_info(debug, caplog):
"""Test that log method excludes exception info when exc_info=False.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> try:
... raise ValueError("Test")
... except ValueError:
... debug.lv1("Error: %s", "info", exc_info=False)
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
try:
raise ValueError("Test error")
except ValueError:
debug.lv1("Error occurred: %s", "info", exc_info=False)
assert "DEBUG1 Error occurred: info" in caplog.text
assert "ValueError: Test error" not in caplog.text
def test_log_with_stack_info(debug, caplog):
"""Test that log method includes stack info when stack_info=True.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value", stack_info=True)
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("Stack info test: %s", "value", stack_info=True)
assert "DEBUG1 Stack info test: value" in caplog.text
assert "Stack (most recent call last):" in caplog.text
def test_log_without_stack_info(debug, caplog):
"""Test that log method excludes stack info when stack_info=False.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value", stack_info=False)
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("No stack info test: %s", "value", stack_info=False)
assert "DEBUG1 No stack info test: value" in caplog.text
assert "Stack (most recent call last):" not in caplog.text
def test_log_with_extra(debug, caplog):
"""Test that log method includes extra metadata when provided.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value", extra={"custom": "value"})
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1(
"Extra test: %s",
"value",
extra={"custom": "custom_value"},
)
assert "DEBUG1 Extra test: value" in caplog.text
assert caplog.records[0].custom == "custom_value"
def test_log_with_extra_none(debug, caplog):
"""Test that log method handles extra=None by setting it to empty dict.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value", extra=None)
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("Extra none test: %s", "value", extra=None)
assert "DEBUG1 Extra none test: value" in caplog.text
# No errors, logs successfully with extra={}
def test_log_all_parameters_combined(debug, caplog):
"""Test log method with exc_info, stack_info, and extra combined.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> try:
... raise ValueError("Test")
... except ValueError:
... debug.lv1("Test: %s", "value", exc_info=True, stack_info=True,
... extra={"custom": "value"})
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
try:
raise ValueError("Combined test error")
except ValueError:
debug.lv1(
"Combined test: %s",
"value",
exc_info=True,
stack_info=True,
stacklevel=4,
extra={"custom": "combined_value"},
)
assert "DEBUG1 Combined test: value" in caplog.text
assert "ValueError: Combined test error" in caplog.text
assert "Stack (most recent call last):" in caplog.text
assert caplog.records[0].custom == "combined_value"
def test_log_with_invalid_extra_type(debug, caplog):
"""Test that log method handles invalid extra type gracefully.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("Test: %s", "value", extra="invalid") # Raises TypeError
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
expected = "Invalid extra test"
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
with pytest.raises(TypeError):
debug.lv1(
"Invalid extra test: %s",
"value",
extra="not_a_dict",
)
assert expected not in caplog.text
def test_log_with_empty_message(debug, caplog):
"""Test that log method handles empty message.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> debug.lv1("") # Should log empty message
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("")
assert "DEBUG1 " in caplog.text # Empty message logged
def test_log_with_multiple_handlers(debug, caplog):
"""Test that log method works with multiple handlers.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler1 = logging.StreamHandler()
>>> handler2 = logging.StreamHandler()
>>> debug.add_handler(handler1)
>>> debug.add_handler(handler2)
>>> debug.lv1("Test: %s", "value")
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
handler1 = logging.StreamHandler()
handler2 = logging.StreamHandler()
formatter = logging.Formatter("%(funcName)s:%(lineno)d %(message)s")
before = len(debug.logger.handlers)
debug.add_handler(handler1, formatter=formatter)
debug.add_handler(handler2, formatter=formatter)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
debug.lv1("Multi-handler test: %s", "value")
assert "DEBUG1 Multi-handler test: value" in caplog.text
assert len(debug.logger.handlers) == before + 2 # Two handlers added
def test_log_performance(debug, caplog):
"""Test that log method performs efficiently with new parameters.
Args:
debug: TieredDebug instance. (TieredDebug)
caplog: Pytest caplog fixture for capturing logs.
Examples:
>>> debug = TieredDebug(level=1)
>>> handler = logging.StreamHandler()
>>> debug.add_handler(handler)
>>> for _ in range(10):
... debug.lv1("Test: %s", "value")
"""
caplog.set_level(logging.DEBUG)
debug.level = 1
debug.add_handler(
logging.StreamHandler(),
formatter=logging.Formatter("%(funcName)s:%(lineno)d %(message)s"),
)
with caplog.at_level(logging.DEBUG, logger=debug.logger.name):
for _ in range(100): # Test 100 log calls
debug.lv1(
"Performance test: %s",
str(_),
extra={"count": _},
)
assert "DEBUG1 Performance test:" in caplog.text
assert len(caplog.records) == 100 # All calls logged
|