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
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import logging
import os
import fixtures
_TRUE_VALUES = ('True', 'true', '1', 'yes')
_FALSE_VALUES = ('False', 'false', '0', 'no')
_LOG_LEVELS = ('DEBUG', 'INFO', 'WARN', 'WARNING', 'ERROR', 'CRITICAL')
class ConfigureLogging(fixtures.Fixture):
"""Configure logging.
The behavior is managed through two environment variables. If
``OS_DEBUG`` is true then the logging level is set to debug. If
``OS_LOG_CAPTURE`` is true a FakeLogger is configured. Alternatively,
``OS_DEBUG`` can be set to an explicit log level, such as ``INFO``.
"True" values include ``True``, ``true``, ``1`` and ``yes``.
Valid log levels include ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR``
and ``CRITICAL``.
.. py:attribute:: logger
The logger fixture, if it is created.
.. py:attribute:: level
``logging.DEBUG`` if debug logging is enabled, otherwise
the log level specified by ``OS_DEBUG``, otherwise ``None``.
:param format: The logging format string to use.
"""
DEFAULT_FORMAT = "%(levelname)8s [%(name)s] %(message)s"
"""Default log format"""
def __init__(self, format=DEFAULT_FORMAT):
super(ConfigureLogging, self).__init__()
self._format = format
self.level = None
_os_debug = os.environ.get('OS_DEBUG')
if _os_debug in _TRUE_VALUES:
self.level = logging.DEBUG
elif _os_debug in _LOG_LEVELS:
self.level = getattr(logging, _os_debug)
elif _os_debug and _os_debug not in _FALSE_VALUES:
raise ValueError('OS_DEBUG=%s is invalid.' % (_os_debug))
self.capture_logs = os.environ.get('OS_LOG_CAPTURE') in _TRUE_VALUES
self.logger = None
def setUp(self):
super(ConfigureLogging, self).setUp()
if self.capture_logs:
self.logger = self.useFixture(
fixtures.FakeLogger(
format=self._format,
level=self.level,
nuke_handlers=True,
)
)
else:
logging.basicConfig(format=self._format, level=self.level)
|
