37a25b340d
The method is redundant and confusingly named. Since the Related-Change it actually returns the aggregate value of counters, not just the count of calls made to the increment method alone. Related-Change: I4d8a4b530465b587caced4362eb9178507701cef Change-Id: I52585567a177f58e0f110785b44f8d238b2ac54d
359 lines
11 KiB
Python
359 lines
11 KiB
Python
# Copyright (c) 2010-2021 OpenStack Foundation
|
|
#
|
|
# 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 collections
|
|
import contextlib
|
|
import logging
|
|
from unittest import mock
|
|
import sys
|
|
|
|
from collections import defaultdict
|
|
|
|
from swift.common import utils, statsd_client
|
|
from swift.common.utils import NOTICE
|
|
|
|
|
|
class WARN_DEPRECATED(Exception):
|
|
def __init__(self, msg):
|
|
self.msg = msg
|
|
print(self.msg)
|
|
|
|
|
|
SendtoCall = collections.namedtuple('SendToCall', ['payload', 'address'])
|
|
|
|
|
|
class RecordingSocket(object):
|
|
def __init__(self):
|
|
self.sendto_calls = []
|
|
|
|
def sendto(self, payload, address):
|
|
self.sendto_calls.append(SendtoCall(payload, address))
|
|
|
|
def close(self):
|
|
pass
|
|
|
|
|
|
class BaseFakeStatsdClient:
|
|
def __init__(self):
|
|
self.clear()
|
|
|
|
# Capture then call parent public stat functions
|
|
self.update_stats = self._capture("update_stats")
|
|
self.increment = self._capture("increment")
|
|
self.decrement = self._capture("decrement")
|
|
self.timing = self._capture("timing")
|
|
self.timing_since = self._capture("timing_since")
|
|
self.transfer_rate = self._capture("transfer_rate")
|
|
|
|
def _capture(self, func_name):
|
|
# this works in subclasses because super() searches the next inherited
|
|
# class after BaseFakeStatsdClient i.e. the real StatsdClient class
|
|
func = getattr(super(BaseFakeStatsdClient, self), func_name)
|
|
|
|
def wrapper(*args, **kwargs):
|
|
self.calls[func_name].append((args, kwargs))
|
|
return func(*args, **kwargs)
|
|
return wrapper
|
|
|
|
def _set_sock_family_and_target(self, host, port):
|
|
self._target = (host, port)
|
|
|
|
def _open_socket(self):
|
|
return self.recording_socket
|
|
|
|
def clear(self):
|
|
self.calls = defaultdict(list)
|
|
self.recording_socket = RecordingSocket()
|
|
self.counters = defaultdict(int)
|
|
|
|
@property
|
|
def sendto_calls(self):
|
|
return self.recording_socket.sendto_calls
|
|
|
|
def get_increments(self):
|
|
"""
|
|
Helper to avoid spelling a tricky list comprehension
|
|
|
|
:returns: a list of the "metric" arg for all calls to increment
|
|
"""
|
|
return [call[0][0] for call in self.calls['increment']]
|
|
|
|
def _update_stats(self, metric, value, *args, **kwargs):
|
|
"""
|
|
Hook into base class primitive to track all "counter" metrics
|
|
"""
|
|
self.counters[metric] += value
|
|
return super()._update_stats(metric, value, *args, **kwargs)
|
|
|
|
# getter for backwards compat
|
|
def get_stats_counts(self):
|
|
return self.counters
|
|
|
|
|
|
class FakeStatsdClient(BaseFakeStatsdClient, statsd_client.StatsdClient):
|
|
def __init__(self, *args, **kwargs):
|
|
super(FakeStatsdClient, self).__init__()
|
|
super(BaseFakeStatsdClient, self).__init__(*args, **kwargs)
|
|
|
|
|
|
class FakeLabeledStatsdClient(BaseFakeStatsdClient,
|
|
statsd_client.LabeledStatsdClient):
|
|
def __init__(self, *args, **kwargs):
|
|
super(FakeLabeledStatsdClient, self).__init__()
|
|
super(BaseFakeStatsdClient, self).__init__(*args, **kwargs)
|
|
|
|
|
|
class CaptureLog(object):
|
|
"""
|
|
Captures log records passed to the ``handle`` method and provides accessor
|
|
functions to the captured logs.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.clear()
|
|
|
|
def _clear(self):
|
|
self.log_dict = defaultdict(list)
|
|
self.lines_dict = {'critical': [], 'error': [], 'info': [],
|
|
'warning': [], 'debug': [], 'notice': []}
|
|
|
|
clear = _clear # this is a public interface
|
|
|
|
def get_lines_for_level(self, level):
|
|
if level not in self.lines_dict:
|
|
raise KeyError(
|
|
"Invalid log level '%s'; valid levels are %s" %
|
|
(level,
|
|
', '.join("'%s'" % lvl for lvl in sorted(self.lines_dict))))
|
|
return self.lines_dict[level]
|
|
|
|
def all_log_lines(self):
|
|
return dict((level, msgs) for level, msgs in self.lines_dict.items()
|
|
if len(msgs) > 0)
|
|
|
|
def _handle(self, record):
|
|
try:
|
|
line = record.getMessage()
|
|
except TypeError:
|
|
print('WARNING: unable to format log message %r %% %r' % (
|
|
record.msg, record.args))
|
|
raise
|
|
self.lines_dict[record.levelname.lower()].append(line)
|
|
return 0
|
|
|
|
def handle(self, record):
|
|
return self._handle(record)
|
|
|
|
|
|
class FakeLogger(logging.Logger, CaptureLog):
|
|
# a thread safe fake logger
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self._clear()
|
|
self.name = kwargs.get('name') or 'swift.unit.fake_logger'
|
|
self.level = logging.NOTSET
|
|
if 'facility' in kwargs:
|
|
self.facility = kwargs['facility']
|
|
self.statsd_client = FakeStatsdClient('host', 8125)
|
|
self.thread_locals = None
|
|
self.parent = None
|
|
# ensure the NOTICE level has been named, in case it has not already
|
|
# been set
|
|
logging.addLevelName(NOTICE, 'NOTICE')
|
|
|
|
store_in = {
|
|
logging.ERROR: 'error',
|
|
logging.WARNING: 'warning',
|
|
logging.INFO: 'info',
|
|
logging.DEBUG: 'debug',
|
|
logging.CRITICAL: 'critical',
|
|
NOTICE: 'notice',
|
|
}
|
|
|
|
def clear(self):
|
|
self._clear()
|
|
self.statsd_client.clear()
|
|
|
|
def close(self):
|
|
self.clear()
|
|
|
|
def warn(self, *args, **kwargs):
|
|
raise WARN_DEPRECATED("Deprecated Method warn use warning instead")
|
|
|
|
def notice(self, msg, *args, **kwargs):
|
|
"""
|
|
Convenience function for syslog priority LOG_NOTICE. The python
|
|
logging lvl is set to 25, just above info. SysLogHandler is
|
|
monkey patched to map this log lvl to the LOG_NOTICE syslog
|
|
priority.
|
|
"""
|
|
self.log(NOTICE, msg, *args, **kwargs)
|
|
|
|
def _log(self, level, msg, *args, **kwargs):
|
|
store_name = self.store_in[level]
|
|
cargs = [msg]
|
|
if any(args):
|
|
cargs.extend(args)
|
|
captured = dict(kwargs)
|
|
if 'exc_info' in kwargs and \
|
|
not isinstance(kwargs['exc_info'], tuple):
|
|
captured['exc_info'] = sys.exc_info()
|
|
self.log_dict[store_name].append((tuple(cargs), captured))
|
|
super(FakeLogger, self)._log(level, msg, *args, **kwargs)
|
|
|
|
def setFormatter(self, obj):
|
|
self.formatter = obj
|
|
|
|
def set_name(self, name):
|
|
# don't touch _handlers
|
|
self._name = name
|
|
|
|
def acquire(self):
|
|
pass
|
|
|
|
def release(self):
|
|
pass
|
|
|
|
def createLock(self):
|
|
pass
|
|
|
|
def emit(self, record):
|
|
pass
|
|
|
|
def flush(self):
|
|
pass
|
|
|
|
def handleError(self, record):
|
|
pass
|
|
|
|
def isEnabledFor(self, level):
|
|
return True
|
|
|
|
|
|
class DebugSwiftLogFormatter(utils.SwiftLogFormatter):
|
|
|
|
def format(self, record):
|
|
msg = super(DebugSwiftLogFormatter, self).format(record)
|
|
return msg.replace('#012', '\n')
|
|
|
|
|
|
class DebugLogger(FakeLogger):
|
|
"""A simple stdout logging version of FakeLogger"""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
FakeLogger.__init__(self, *args, **kwargs)
|
|
self.formatter = DebugSwiftLogFormatter(
|
|
"%(server)s %(levelname)s: %(message)s")
|
|
self.records = defaultdict(list)
|
|
|
|
def handle(self, record):
|
|
self._handle(record)
|
|
formatted = self.formatter.format(record)
|
|
print(formatted)
|
|
self.records[record.levelname].append(formatted)
|
|
|
|
|
|
class DebugLogAdapter(utils.logs.SwiftLogAdapter):
|
|
def __init__(self, *args, **kwargs):
|
|
super(DebugLogAdapter, self).__init__(*args, **kwargs)
|
|
self.txn_id = None
|
|
|
|
def __getattribute__(self, name):
|
|
try:
|
|
return object.__getattribute__(self, name)
|
|
except AttributeError:
|
|
return getattr(self.__dict__['logger'], name)
|
|
|
|
|
|
def debug_logger(name='test', log_route=None):
|
|
"""get a named adapted debug logger"""
|
|
log_route = log_route or name
|
|
adapted_logger = DebugLogAdapter(DebugLogger(name=log_route), name)
|
|
utils._patch_statsd_methods(adapted_logger, adapted_logger.logger)
|
|
return adapted_logger
|
|
|
|
|
|
def debug_statsd_client(conf):
|
|
"""get a configured statsd client"""
|
|
with mock.patch('swift.common.statsd_client.StatsdClient',
|
|
FakeStatsdClient):
|
|
return statsd_client.get_statsd_client(conf)
|
|
|
|
|
|
def debug_labeled_statsd_client(conf):
|
|
"""get a configured labeled statsd client"""
|
|
with mock.patch('swift.common.statsd_client.LabeledStatsdClient',
|
|
FakeLabeledStatsdClient):
|
|
return statsd_client.get_labeled_statsd_client(conf)
|
|
|
|
|
|
class ForwardingLogHandler(logging.NullHandler):
|
|
"""
|
|
Provides a LogHandler implementation that simply forwards filtered records
|
|
to a given handler function. This can be useful to forward records to a
|
|
handler without the handler itself needing to subclass LogHandler.
|
|
"""
|
|
|
|
def __init__(self, handler_fn):
|
|
super(ForwardingLogHandler, self).__init__()
|
|
self.handler_fn = handler_fn
|
|
|
|
def handle(self, record):
|
|
return self.handler_fn(record)
|
|
|
|
|
|
class CaptureLogAdapter(utils.logs.SwiftLogAdapter, CaptureLog):
|
|
"""
|
|
A LogAdapter that is capable of capturing logs for inspection via accessor
|
|
methods.
|
|
"""
|
|
|
|
def __init__(self, logger, name):
|
|
super(CaptureLogAdapter, self).__init__(logger, name)
|
|
self.clear()
|
|
self.handler = ForwardingLogHandler(self.handle)
|
|
|
|
def start_capture(self):
|
|
"""
|
|
Attaches the adapter's handler to the adapted logger in order to start
|
|
capturing log messages.
|
|
"""
|
|
self.logger.addHandler(self.handler)
|
|
|
|
def stop_capture(self):
|
|
"""
|
|
Detaches the adapter's handler from the adapted logger. This should be
|
|
called to prevent further logging to the adapted logger (possibly via
|
|
other log adapter instances) being captured by this instance.
|
|
"""
|
|
self.logger.removeHandler(self.handler)
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def capture_logger(conf, *args, **kwargs):
|
|
"""
|
|
Yields an adapted system logger based on the conf options. The log adapter
|
|
captures logs in order to support the pattern of tests calling the log
|
|
accessor methods (e.g. get_lines_for_level) directly on the logger
|
|
instance.
|
|
"""
|
|
with mock.patch('swift.common.utils.logs.SwiftLogAdapter',
|
|
CaptureLogAdapter):
|
|
log_adapter = utils.get_logger(conf, *args, **kwargs)
|
|
log_adapter.start_capture()
|
|
try:
|
|
yield log_adapter
|
|
finally:
|
|
log_adapter.stop_capture()
|