fa76db361c
* Fixes lp904305 * remove module level log functions (getLogger to rule them all) * Move specific Environment logging to the one place it is used * Wrap getLogger to return a logger wrapped in a NovaContextAdapter * Do not overwrite the root logger * save_and_reraise_exception logs via error for passing exc_info * Uses CommonConfigOptions for compatability across Openstack Projects * Prefers CommonConfigOptions over legacy options * Install a NullHandler on the root logger if configured by FLAGS * Include example logging config file to mimic Nova defaults Change-Id: Ie59c3f755c142e2b7dc3b94b4e82e142e157bfac
127 lines
4.5 KiB
Python
127 lines
4.5 KiB
Python
import cStringIO
|
|
import logging
|
|
|
|
from nova import context
|
|
from nova import flags
|
|
from nova import log
|
|
from nova import test
|
|
|
|
FLAGS = flags.FLAGS
|
|
|
|
|
|
def _fake_context():
|
|
return context.RequestContext(1, 1)
|
|
|
|
|
|
class LoggerTestCase(test.TestCase):
|
|
def setUp(self):
|
|
super(LoggerTestCase, self).setUp()
|
|
self.log = log.getLogger()
|
|
|
|
def test_handlers_have_nova_formatter(self):
|
|
formatters = []
|
|
for h in self.log.logger.handlers:
|
|
f = h.formatter
|
|
if isinstance(f, log.LegacyNovaFormatter):
|
|
formatters.append(f)
|
|
self.assert_(formatters)
|
|
self.assertEqual(len(formatters), len(self.log.logger.handlers))
|
|
|
|
def test_handles_context_kwarg(self):
|
|
self.log.info("foo", context=_fake_context())
|
|
self.assert_(True) # didn't raise exception
|
|
|
|
def test_audit_handles_context_arg(self):
|
|
self.log.audit("foo", context=_fake_context())
|
|
self.assert_(True) # didn't raise exception
|
|
|
|
def test_will_be_verbose_if_verbose_flag_set(self):
|
|
self.flags(verbose=True)
|
|
log.setup()
|
|
self.assertEqual(logging.DEBUG, self.log.logger.getEffectiveLevel())
|
|
|
|
def test_will_not_be_verbose_if_verbose_flag_not_set(self):
|
|
self.flags(verbose=False)
|
|
log.setup()
|
|
self.assertEqual(logging.INFO, self.log.logger.getEffectiveLevel())
|
|
|
|
def test_no_logging_via_module(self):
|
|
for func in ('critical', 'error', 'exception', 'warning', 'warn',
|
|
'info', 'debug', 'log', 'audit'):
|
|
self.assertRaises(AttributeError, getattr, log, func)
|
|
|
|
|
|
class LogHandlerTestCase(test.TestCase):
|
|
def test_log_path_logdir(self):
|
|
self.flags(logdir='/some/path', logfile=None)
|
|
self.assertEquals(log._get_log_file_path(binary='foo-bar'),
|
|
'/some/path/foo-bar.log')
|
|
|
|
def test_log_path_logfile(self):
|
|
self.flags(logfile='/some/path/foo-bar.log')
|
|
self.assertEquals(log._get_log_file_path(binary='foo-bar'),
|
|
'/some/path/foo-bar.log')
|
|
|
|
def test_log_path_none(self):
|
|
self.flags(logdir=None, logfile=None)
|
|
self.assertTrue(log._get_log_file_path(binary='foo-bar') is None)
|
|
|
|
def test_log_path_logfile_overrides_logdir(self):
|
|
self.flags(logdir='/some/other/path',
|
|
logfile='/some/path/foo-bar.log')
|
|
self.assertEquals(log._get_log_file_path(binary='foo-bar'),
|
|
'/some/path/foo-bar.log')
|
|
|
|
|
|
class NovaFormatterTestCase(test.TestCase):
|
|
def setUp(self):
|
|
super(NovaFormatterTestCase, self).setUp()
|
|
self.flags(logging_context_format_string="HAS CONTEXT "\
|
|
"[%(request_id)s]: %(message)s",
|
|
logging_default_format_string="NOCTXT: %(message)s",
|
|
logging_debug_format_suffix="--DBG")
|
|
self.log = log.getLogger()
|
|
self.stream = cStringIO.StringIO()
|
|
self.handler = logging.StreamHandler(self.stream)
|
|
self.handler.setFormatter(log.LegacyNovaFormatter())
|
|
self.log.logger.addHandler(self.handler)
|
|
self.level = self.log.logger.getEffectiveLevel()
|
|
self.log.logger.setLevel(logging.DEBUG)
|
|
|
|
def tearDown(self):
|
|
self.log.logger.setLevel(self.level)
|
|
self.log.logger.removeHandler(self.handler)
|
|
super(NovaFormatterTestCase, self).tearDown()
|
|
|
|
def test_uncontextualized_log(self):
|
|
self.log.info("foo")
|
|
self.assertEqual("NOCTXT: foo\n", self.stream.getvalue())
|
|
|
|
def test_contextualized_log(self):
|
|
ctxt = _fake_context()
|
|
self.log.info("bar", context=ctxt)
|
|
expected = "HAS CONTEXT [%s]: bar\n" % ctxt.request_id
|
|
self.assertEqual(expected, self.stream.getvalue())
|
|
|
|
def test_debugging_log(self):
|
|
self.log.debug("baz")
|
|
self.assertEqual("NOCTXT: baz --DBG\n", self.stream.getvalue())
|
|
|
|
|
|
class NovaLoggerTestCase(test.TestCase):
|
|
def setUp(self):
|
|
super(NovaLoggerTestCase, self).setUp()
|
|
levels = FLAGS.default_log_levels
|
|
levels.append("nova-test=AUDIT")
|
|
self.flags(default_log_levels=levels,
|
|
verbose=True)
|
|
log.setup()
|
|
self.log = log.getLogger('nova-test')
|
|
|
|
def test_has_level_from_flags(self):
|
|
self.assertEqual(logging.AUDIT, self.log.logger.getEffectiveLevel())
|
|
|
|
def test_child_log_has_level_of_parent_flag(self):
|
|
l = log.getLogger('nova-test.foo')
|
|
self.assertEqual(logging.AUDIT, l.logger.getEffectiveLevel())
|