/usr/share/pyshared/ZConfig/components/logger/tests/test_logger.py is in python-zconfig 2.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Tests for logging configuration via ZConfig."""
import cStringIO as StringIO
import doctest
import logging
import os
import sys
import tempfile
import unittest
import ZConfig
from ZConfig.components.logger import datatypes
from ZConfig.components.logger import handlers
from ZConfig.components.logger import loghandler
class CustomFormatter(logging.Formatter):
def formatException(self, ei):
"""Format and return the exception information as a string.
This adds helpful advice to the end of the traceback.
"""
import traceback
sio = StringIO.StringIO()
traceback.print_exception(ei[0], ei[1], ei[2], file=sio)
return sio.getvalue() + "... Don't panic!"
class LoggingTestBase(unittest.TestCase):
# XXX This tries to save and restore the state of logging around
# the test. Somewhat surgical; there may be a better way.
def setUp(self):
self._created = []
self._old_logger = logging.getLogger()
self._old_level = self._old_logger.level
self._old_handlers = self._old_logger.handlers[:]
self._old_logger.handlers[:] = []
self._old_logger.setLevel(logging.WARN)
self._old_logger_dict = logging.root.manager.loggerDict.copy()
logging.root.manager.loggerDict.clear()
def tearDown(self):
logging.root.manager.loggerDict.clear()
logging.root.manager.loggerDict.update(self._old_logger_dict)
for h in self._old_logger.handlers:
self._old_logger.removeHandler(h)
for h in self._old_handlers:
self._old_logger.addHandler(h)
self._old_logger.setLevel(self._old_level)
while self._created:
os.unlink(self._created.pop())
self.assertEqual(loghandler._reopenable_handlers, [])
loghandler.closeFiles()
loghandler._reopenable_handlers == []
def mktemp(self):
fd, fn = tempfile.mkstemp()
os.close(fd)
self._created.append(fn)
return fn
def move(self, fn):
nfn = self.mktemp()
os.rename(fn, nfn)
return nfn
_schema = None
def get_schema(self):
if self._schema is None:
sio = StringIO.StringIO(self._schematext)
self.__class__._schema = ZConfig.loadSchemaFile(sio)
return self._schema
def get_config(self, text):
conf, handler = ZConfig.loadConfigFile(self.get_schema(),
StringIO.StringIO(text))
self.assert_(not handler)
return conf
class TestConfig(LoggingTestBase):
_schematext = """
<schema>
<import package='ZConfig.components.logger'/>
<section type='eventlog' name='*' attribute='eventlog'/>
</schema>
"""
def test_logging_level(self):
# Make sure the expected names are supported; it's not clear
# how to check the values in a meaningful way.
# Just make sure they're case-insensitive.
convert = datatypes.logging_level
for name in ["notset", "all", "trace", "debug", "blather",
"info", "warn", "warning", "error", "fatal",
"critical"]:
self.assertEqual(convert(name), convert(name.upper()))
self.assertRaises(ValueError, convert, "hopefully-not-a-valid-value")
def test_http_method(self):
convert = handlers.get_or_post
self.assertEqual(convert("get"), "GET")
self.assertEqual(convert("GET"), "GET")
self.assertEqual(convert("post"), "POST")
self.assertEqual(convert("POST"), "POST")
self.assertRaises(ValueError, convert, "")
self.assertRaises(ValueError, convert, "foo")
def test_syslog_facility(self):
convert = handlers.syslog_facility
for name in ["auth", "authpriv", "cron", "daemon", "kern",
"lpr", "mail", "news", "security", "syslog",
"user", "uucp", "local0", "local1", "local2",
"local3", "local4", "local5", "local6", "local7"]:
self.assertEqual(convert(name), name)
self.assertEqual(convert(name.upper()), name)
self.assertRaises(ValueError, convert, "hopefully-never-a-valid-value")
def test_config_without_logger(self):
conf = self.get_config("")
self.assert_(conf.eventlog is None)
def test_config_without_handlers(self):
logger = self.check_simple_logger("<eventlog/>")
# Make sure there's a NullHandler, since a warning gets
# printed if there are no handlers:
self.assertEqual(len(logger.handlers), 1)
self.assert_(isinstance(logger.handlers[0],
loghandler.NullHandler))
def test_with_logfile(self):
fn = self.mktemp()
logger = self.check_simple_logger("<eventlog>\n"
" <logfile>\n"
" path %s\n"
" level debug\n"
" </logfile>\n"
"</eventlog>" % fn)
logfile = logger.handlers[0]
self.assertEqual(logfile.level, logging.DEBUG)
self.assert_(isinstance(logfile, loghandler.FileHandler))
logger.removeHandler(logfile)
logfile.close()
def test_with_stderr(self):
self.check_standard_stream("stderr")
def test_with_stdout(self):
self.check_standard_stream("stdout")
def test_with_rotating_logfile(self):
fn = self.mktemp()
logger = self.check_simple_logger("<eventlog>\n"
" <logfile>\n"
" path %s\n"
" level debug\n"
" max-size 5mb\n"
" old-files 10\n"
" </logfile>\n"
"</eventlog>" % fn)
logfile = logger.handlers[0]
self.assertEqual(logfile.level, logging.DEBUG)
self.assertEqual(logfile.backupCount, 10)
self.assertEqual(logfile.maxBytes, 5*1024*1024)
self.assert_(isinstance(logfile, loghandler.RotatingFileHandler))
logger.removeHandler(logfile)
logfile.close()
def test_with_timed_rotating_logfile(self):
fn = self.mktemp()
logger = self.check_simple_logger("<eventlog>\n"
" <logfile>\n"
" path %s\n"
" level debug\n"
" when D\n"
" old-files 11\n"
" </logfile>\n"
"</eventlog>" % fn)
logfile = logger.handlers[0]
self.assertEqual(logfile.level, logging.DEBUG)
self.assertEqual(logfile.backupCount, 11)
self.assertEqual(logfile.interval, 86400)
self.assert_(isinstance(logfile, loghandler.TimedRotatingFileHandler))
logger.removeHandler(logfile)
logfile.close()
def test_with_timed_rotating_logfile(self):
fn = self.mktemp()
logger = self.check_simple_logger("<eventlog>\n"
" <logfile>\n"
" path %s\n"
" level debug\n"
" when D\n"
" interval 3\n"
" old-files 11\n"
" </logfile>\n"
"</eventlog>" % fn)
logfile = logger.handlers[0]
self.assertEqual(logfile.level, logging.DEBUG)
self.assertEqual(logfile.backupCount, 11)
self.assertEqual(logfile.interval, 86400*3)
self.assert_(isinstance(logfile, loghandler.TimedRotatingFileHandler))
logger.removeHandler(logfile)
logfile.close()
def test_with_timed_rotating_logfile_and_size_should_fail(self):
fn = self.mktemp()
self.assertRaises(
ValueError,
self.check_simple_logger, "<eventlog>\n"
" <logfile>\n"
" path %s\n"
" level debug\n"
" max-size 5mb\n"
" when D\n"
" old-files 10\n"
" </logfile>\n"
"</eventlog>" % fn)
def check_standard_stream(self, name):
old_stream = getattr(sys, name)
conf = self.get_config("""
<eventlog>
<logfile>
level info
path %s
</logfile>
</eventlog>
""" % name.upper())
self.assert_(conf.eventlog is not None)
# The factory has already been created; make sure it picks up
# the stderr we set here when we create the logger and
# handlers:
sio = StringIO.StringIO()
setattr(sys, name, sio)
try:
logger = conf.eventlog()
finally:
setattr(sys, name, old_stream)
logger.warn("woohoo!")
self.assert_(sio.getvalue().find("woohoo!") >= 0)
def test_custom_formatter(self):
old_stream = sys.stdout
conf = self.get_config("""
<eventlog>
<logfile>
formatter ZConfig.components.logger.tests.test_logger.CustomFormatter
level info
path STDOUT
</logfile>
</eventlog>
""")
sio = StringIO.StringIO()
sys.stdout = sio
try:
logger = conf.eventlog()
finally:
sys.stdout = old_stream
try:
raise KeyError
except KeyError:
logger.exception("testing a KeyError")
self.assert_(sio.getvalue().find("KeyError") >= 0)
self.assert_(sio.getvalue().find("Don't panic") >= 0)
def test_with_syslog(self):
logger = self.check_simple_logger("<eventlog>\n"
" <syslog>\n"
" level error\n"
" facility local3\n"
" </syslog>\n"
"</eventlog>")
syslog = logger.handlers[0]
self.assertEqual(syslog.level, logging.ERROR)
self.assert_(isinstance(syslog, loghandler.SysLogHandler))
def test_with_http_logger_localhost(self):
logger = self.check_simple_logger("<eventlog>\n"
" <http-logger>\n"
" level error\n"
" method post\n"
" </http-logger>\n"
"</eventlog>")
handler = logger.handlers[0]
self.assertEqual(handler.host, "localhost")
# XXX The "url" attribute of the handler is misnamed; it
# really means just the selector portion of the URL.
self.assertEqual(handler.url, "/")
self.assertEqual(handler.level, logging.ERROR)
self.assertEqual(handler.method, "POST")
self.assert_(isinstance(handler, loghandler.HTTPHandler))
def test_with_http_logger_remote_host(self):
logger = self.check_simple_logger("<eventlog>\n"
" <http-logger>\n"
" method get\n"
" url http://example.com/log/\n"
" </http-logger>\n"
"</eventlog>")
handler = logger.handlers[0]
self.assertEqual(handler.host, "example.com")
# XXX The "url" attribute of the handler is misnamed; it
# really means just the selector portion of the URL.
self.assertEqual(handler.url, "/log/")
self.assertEqual(handler.level, logging.NOTSET)
self.assertEqual(handler.method, "GET")
self.assert_(isinstance(handler, loghandler.HTTPHandler))
def test_with_email_notifier(self):
logger = self.check_simple_logger("<eventlog>\n"
" <email-notifier>\n"
" to sysadmin@example.com\n"
" to sa-pager@example.com\n"
" from zlog-user@example.com\n"
" level fatal\n"
" </email-notifier>\n"
"</eventlog>")
handler = logger.handlers[0]
self.assertEqual(handler.toaddrs, ["sysadmin@example.com",
"sa-pager@example.com"])
self.assertEqual(handler.fromaddr, "zlog-user@example.com")
self.assertEqual(handler.level, logging.FATAL)
def test_with_email_notifier_with_credentials(self):
try:
logger = self.check_simple_logger("<eventlog>\n"
" <email-notifier>\n"
" to sysadmin@example.com\n"
" from zlog-user@example.com\n"
" level fatal\n"
" smtp-username john\n"
" smtp-password johnpw\n"
" </email-notifier>\n"
"</eventlog>")
except ValueError:
if sys.version_info >= (2, 6):
# For python 2.6 no ValueError must be raised.
raise
else:
# This path must only be reached with python >=2.6
self.assert_(sys.version_info >= (2, 6))
handler = logger.handlers[0]
self.assertEqual(handler.toaddrs, ["sysadmin@example.com"])
self.assertEqual(handler.fromaddr, "zlog-user@example.com")
self.assertEqual(handler.fromaddr, "zlog-user@example.com")
self.assertEqual(handler.level, logging.FATAL)
self.assertEqual(handler.username, 'john')
self.assertEqual(handler.password, 'johnpw')
def test_with_email_notifier_with_invalid_credentials(self):
self.assertRaises(ValueError,
self.check_simple_logger,
"<eventlog>\n"
" <email-notifier>\n"
" to sysadmin@example.com\n"
" from zlog-user@example.com\n"
" level fatal\n"
" smtp-username john\n"
" </email-notifier>\n"
"</eventlog>")
self.assertRaises(ValueError,
self.check_simple_logger,
"<eventlog>\n"
" <email-notifier>\n"
" to sysadmin@example.com\n"
" from zlog-user@example.com\n"
" level fatal\n"
" smtp-password john\n"
" </email-notifier>\n"
"</eventlog>")
def check_simple_logger(self, text, level=logging.INFO):
conf = self.get_config(text)
self.assert_(conf.eventlog is not None)
self.assertEqual(conf.eventlog.level, level)
logger = conf.eventlog()
self.assert_(isinstance(logger, logging.Logger))
self.assertEqual(len(logger.handlers), 1)
return logger
class TestReopeningLogfilesBase(LoggingTestBase):
# These tests should not be run on Windows.
_schematext = """
<schema>
<import package='ZConfig.components.logger'/>
<multisection type='logger' name='*' attribute='loggers'/>
</schema>
"""
def test_filehandler_reopen(self):
def mkrecord(msg):
#
# Python 2.5.0 added an additional required argument to the
# LogRecord constructor, making it incompatible with prior
# versions. Python 2.5.1 corrected the bug by making the
# additional argument optional. We deal with 2.5.0 by adding
# the extra arg in only that case, using the default value
# from Python 2.5.1.
#
args = ["foo.bar", logging.ERROR, __file__, 42, msg, (), ()]
if sys.version_info[:3] == (2, 5, 0):
args.append(None)
return logging.LogRecord(*args)
# This goes through the reopening operation *twice* to make
# sure that we don't lose our handle on the handler the first
# time around.
fn = self.mktemp()
h = self.handler_factory(fn)
h.handle(mkrecord("message 1"))
nfn1 = self.move(fn)
h.handle(mkrecord("message 2"))
h.reopen()
h.handle(mkrecord("message 3"))
nfn2 = self.move(fn)
h.handle(mkrecord("message 4"))
h.reopen()
h.handle(mkrecord("message 5"))
h.close()
# Check that the messages are in the right files::
text1 = open(nfn1).read()
text2 = open(nfn2).read()
text3 = open(fn).read()
self.assert_("message 1" in text1)
self.assert_("message 2" in text1)
self.assert_("message 3" in text2)
self.assert_("message 4" in text2)
self.assert_("message 5" in text3)
class TestReopeningLogfiles(TestReopeningLogfilesBase):
handler_factory = loghandler.FileHandler
_sampleconfig_template = """
<logger>
name foo.bar
<logfile>
path %(path0)s
level debug
</logfile>
<logfile>
path %(path1)s
level info
</logfile>
</logger>
<logger>
name bar.foo
<logfile>
path %(path2)s
level info
</logfile>
</logger>
"""
def test_logfile_reopening(self):
#
# This test only applies to the simple logfile reopening; it
# doesn't work the same way as the rotating logfile handler.
#
paths = self.mktemp(), self.mktemp(), self.mktemp()
d = {
"path0": paths[0],
"path1": paths[1],
"path2": paths[2],
}
text = self._sampleconfig_template % d
conf = self.get_config(text)
self.assertEqual(len(conf.loggers), 2)
# Build the loggers from the configuration, and write to them:
conf.loggers[0]().info("message 1")
conf.loggers[1]().info("message 2")
npaths1 = [self.move(fn) for fn in paths]
#
# We expect this to re-open the original filenames, so we'll
# have six files instead of three.
#
loghandler.reopenFiles()
#
# Write to them again:
conf.loggers[0]().info("message 3")
conf.loggers[1]().info("message 4")
npaths2 = [self.move(fn) for fn in paths]
#
# We expect this to re-open the original filenames, so we'll
# have nine files instead of six.
#
loghandler.reopenFiles()
#
# Write to them again:
conf.loggers[0]().info("message 5")
conf.loggers[1]().info("message 6")
#
# We should now have all nine files:
for fn in paths:
self.assert_(os.path.isfile(fn), "%r must exist" % fn)
for fn in npaths1:
self.assert_(os.path.isfile(fn), "%r must exist" % fn)
for fn in npaths2:
self.assert_(os.path.isfile(fn), "%r must exist" % fn)
#
# Clean up:
for logger in conf.loggers:
logger = logger()
for handler in logger.handlers[:]:
logger.removeHandler(handler)
handler.close()
class TestReopeningRotatingLogfiles(TestReopeningLogfilesBase):
_sampleconfig_template = """
<logger>
name foo.bar
<logfile>
path %(path0)s
level debug
max-size 1mb
old-files 10
</logfile>
<logfile>
path %(path1)s
level info
max-size 1mb
old-files 3
</logfile>
<logfile>
path %(path1)s
level info
when D
old-files 3
</logfile>
</logger>
<logger>
name bar.foo
<logfile>
path %(path2)s
level info
max-size 10mb
old-files 10
</logfile>
</logger>
"""
handler_factory = loghandler.RotatingFileHandler
def test_logfile_reopening(self):
#
# This test only applies to the simple logfile reopening; it
# doesn't work the same way as the rotating logfile handler.
#
paths = self.mktemp(), self.mktemp(), self.mktemp()
d = {
"path0": paths[0],
"path1": paths[1],
"path2": paths[2],
}
text = self._sampleconfig_template % d
conf = self.get_config(text)
self.assertEqual(len(conf.loggers), 2)
# Build the loggers from the configuration, and write to them:
conf.loggers[0]().info("message 1")
conf.loggers[1]().info("message 2")
#
# We expect this to re-open the original filenames, so we'll
# have six files instead of three.
#
loghandler.reopenFiles()
#
# Write to them again:
conf.loggers[0]().info("message 3")
conf.loggers[1]().info("message 4")
#
# We expect this to re-open the original filenames, so we'll
# have nine files instead of six.
#
loghandler.reopenFiles()
#
# Write to them again:
conf.loggers[0]().info("message 5")
conf.loggers[1]().info("message 6")
#
# We should now have all nine files:
for fn in paths:
fn1 = fn + ".1"
fn2 = fn + ".2"
self.assert_(os.path.isfile(fn), "%r must exist" % fn)
self.assert_(os.path.isfile(fn1), "%r must exist" % fn1)
self.assert_(os.path.isfile(fn2), "%r must exist" % fn2)
#
# Clean up:
for logger in conf.loggers:
logger = logger()
for handler in logger.handlers[:]:
logger.removeHandler(handler)
handler.close()
def test_logger_convenience_function_and_ommiting_name_to_get_root_logger():
"""
The ZConfig.loggers function can be used to configure one or more loggers.
We'll configure the rot logger and a non-root logger.
>>> old_level = logging.getLogger().getEffectiveLevel()
>>> old_handler_count = len(logging.getLogger().handlers)
>>> ZConfig.configureLoggers('''
... <logger>
... level INFO
... <logfile>
... PATH STDOUT
... format root %(levelname)s %(name)s %(message)s
... </logfile>
... </logger>
...
... <logger>
... name ZConfig.TEST
... level DEBUG
... <logfile>
... PATH STDOUT
... format test %(levelname)s %(name)s %(message)s
... </logfile>
... </logger>
... ''')
>>> logging.getLogger('ZConfig.TEST').debug('test message')
test DEBUG ZConfig.TEST test message
root DEBUG ZConfig.TEST test message
>>> logging.getLogger().getEffectiveLevel() == logging.INFO
True
>>> len(logging.getLogger().handlers) == old_handler_count + 1
True
>>> logging.getLogger('ZConfig.TEST').getEffectiveLevel() == logging.DEBUG
True
>>> len(logging.getLogger('ZConfig.TEST').handlers) == 1
True
.. cleanup
>>> logging.getLogger('ZConfig.TEST').setLevel(logging.NOTSET)
>>> logging.getLogger('ZConfig.TEST').removeHandler(
... logging.getLogger('ZConfig.TEST').handlers[-1])
>>> logging.getLogger().setLevel(old_level)
>>> logging.getLogger().removeHandler(logging.getLogger().handlers[-1])
"""
def test_suite():
suite = unittest.TestSuite()
suite.addTest(doctest.DocTestSuite())
suite.addTest(unittest.makeSuite(TestConfig))
if os.name != "nt":
# Though log files can be closed and re-opened on Windows, these
# tests expect to be able to move the underlying files out from
# underneath the logger while open. That's not possible on
# Windows.
#
# Different tests are needed that only test that close/re-open
# operations are performed by the handler; those can be run on
# any platform.
suite.addTest(unittest.makeSuite(TestReopeningLogfiles))
suite.addTest(unittest.makeSuite(TestReopeningRotatingLogfiles))
return suite
if __name__ == '__main__':
unittest.main(defaultTest="test_suite")
|