starlingx/monitoring
Code Issues Proposed changes

Enable Flake8 Docstring Errors

Browse Source 
Flake8 currently ignores the following errors:
H401: docstring should not start with a space
H404: multi line docstring should start without a leading new line
H405: multi line docstring summary not separated with an empty line
Enable them for more consistent formatting of docstrings

Change-Id: I385e28e9c6eca3c02a3def51ff64b00b7a63a853
Story: 2004515
Task: 30076
Signed-off-by: Eric Barrett <eric.barrett@windriver.com>
This commit is contained in:
Eric Barrett 2019-04-18 09:11:20 -04:00
parent 70bbb84587
commit 7c67589b1b
11 changed files with 119 additions and 177 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
collectd-extensions/src/cpu.py
View File

@ -41,7 +41,7 @@ class CPU:
time_last = float(0.0) # float of the time the last sample was taken time_last = float(0.0) # float of the time the last sample was taken
def log_error(self, err_str): def log_error(self, err_str):
""" Print an error log with plugin name prefixing the log """ """Print an error log with plugin name prefixing the log"""
collectd.error("%s %s" % (PLUGIN, err_str)) collectd.error("%s %s" % (PLUGIN, err_str))

4
collectd-extensions/src/example.py
View File

@ -24,9 +24,7 @@ obj = ExampleObject()
# The config function - called once on collectd process startup # The config function - called once on collectd process startup
def config_func(config): def config_func(config):
""" """Configure the plugin"""
Configure the plugin
"""
for node in config.children: for node in config.children:
key = node.key.lower() key = node.key.lower()

84
collectd-extensions/src/fm_notifier.py
View File

@ -217,9 +217,7 @@ class PluginObject:
database_setup_in_progress = False # connection mutex database_setup_in_progress = False # connection mutex
def __init__(self, id, plugin): def __init__(self, id, plugin):
""" """PluginObject Class constructor"""
PluginObject Class constructor
"""
# plugin specific static class members. # plugin specific static class members.
self.id = id # alarm id ; 100.1?? self.id = id # alarm id ; 100.1??
@ -272,27 +270,20 @@ class PluginObject:
# For plugins that have multiple instances like df (filesystem plugin) # For plugins that have multiple instances like df (filesystem plugin)
# we need to create an instance of this object for each one. # we need to create an instance of this object for each one.
# This dictionary is used to associate a instance with its object. # This dictionary is used to associate an instance with its object.
self.instance_objects = {} self.instance_objects = {}
def _ilog(self, string): def _ilog(self, string):
""" """Create a collectd notifier info log with the string param"""
Create a collectd notifier info log with the specified string.
"""
collectd.info('%s %s : %s' % (PLUGIN, self.plugin, string)) collectd.info('%s %s : %s' % (PLUGIN, self.plugin, string))
def _llog(self, string): def _llog(self, string):
""" """Create a collectd notifier info log with the string param if debug_lists"""
Create a collectd notifier info log with the specified string
if debug_lists is True.
"""
if debug_lists: if debug_lists:
collectd.info('%s %s : %s' % (PLUGIN, self.plugin, string)) collectd.info('%s %s : %s' % (PLUGIN, self.plugin, string))
def _elog(self, string): def _elog(self, string):
""" """Create a collectd notifier error log with the string param"""
Create a collectd notifier error log with the specified string.
"""
collectd.error('%s %s : %s' % (PLUGIN, self.plugin, string)) collectd.error('%s %s : %s' % (PLUGIN, self.plugin, string))
########################################################################## ##########################################################################
@ -310,7 +301,7 @@ class PluginObject:
########################################################################## ##########################################################################
def _state_audit(self, location): def _state_audit(self, location):
""" Log the state of the specified object. """ """Log the state of the specified object"""
if self.id == ALARM_ID__CPU: if self.id == ALARM_ID__CPU:
_print_state() _print_state()
@ -346,7 +337,7 @@ class PluginObject:
########################################################################## ##########################################################################
def _manage_change(self, nObject): def _manage_change(self, nObject):
""" Log resource instance value on step state change. """ """Log resource instance value on step state change"""
# filter out messages to ignore ; notifications that have no value # filter out messages to ignore ; notifications that have no value
if "has not been updated for" in nObject.message: if "has not been updated for" in nObject.message:
@ -495,9 +486,7 @@ class PluginObject:
########################################################################## ##########################################################################
def _severity_change(self, entity_id, severity): def _severity_change(self, entity_id, severity):
""" """Check for a severity change"""
Check for a severity change
"""
if entity_id in self.warnings: if entity_id in self.warnings:
self._llog(entity_id + " is already in warnings list") self._llog(entity_id + " is already in warnings list")
@ -561,9 +550,7 @@ class PluginObject:
######################################################################### #########################################################################
def _manage_alarm(self, entity_id, severity): def _manage_alarm(self, entity_id, severity):
""" """Manage the alarm severity lists and report state change"""
Manage the alarm severity lists and report state change.
"""
collectd.debug("%s manage alarm %s %s %s" % collectd.debug("%s manage alarm %s %s %s" %
(PLUGIN, (PLUGIN,
@ -675,10 +662,9 @@ class PluginObject:
# #
########################################################################## ##########################################################################
def _get_instance_object(self, eid): def _get_instance_object(self, eid):
""" """Safely get an object from the self instance object dict while locked
Safely get an object from the self instance object list indexed
by eid while locked. :param eid: the index for the instance object dictionary
:param eid:
:return: object or None :return: object or None
""" """
@ -707,10 +693,10 @@ class PluginObject:
# #
########################################################################## ##########################################################################
def _add_instance_object(self, obj, eid): def _add_instance_object(self, obj, eid):
""" """Update self instance_objects list while locked
Update self instance_objects list while locked
:param obj: the object to add :param obj: the object to add
:param eid: indexed by this eid :param eid: index for instance_objects
:return: nothing :return: nothing
""" """
try: try:
@ -734,9 +720,7 @@ class PluginObject:
# #
########################################################################## ##########################################################################
def _copy_instance_object(self, object): def _copy_instance_object(self, object):
""" """Copy select members of self object to target object"""
Copy select members of self object to target object
"""
object.resource_name = self.resource_name object.resource_name = self.resource_name
object.instance_name = self.instance_name object.instance_name = self.instance_name
@ -802,9 +786,7 @@ class PluginObject:
# #
########################################################################## ##########################################################################
def _create_instance_objects(self): def _create_instance_objects(self):
""" """Create, initialize and add an instance object to this/self plugin"""
Create, initialize and add an instance object to this/self plugin
"""
# Create the File System subordinate instance objects. # Create the File System subordinate instance objects.
if self.id == ALARM_ID__DF: if self.id == ALARM_ID__DF:
@ -880,9 +862,7 @@ PLUGINS = {
def _get_base_object(alarm_id): def _get_base_object(alarm_id):
""" """Get the alarm object for the specified alarm id"""
Get the alarm object for the specified alarm id.
"""
for plugin in PLUGIN_NAME_LIST: for plugin in PLUGIN_NAME_LIST:
if PLUGINS[plugin].id == alarm_id: if PLUGINS[plugin].id == alarm_id:
return PLUGINS[plugin] return PLUGINS[plugin]
@ -890,9 +870,7 @@ def _get_base_object(alarm_id):
def _get_object(alarm_id, eid): def _get_object(alarm_id, eid):
""" """Get the plugin object for the specified alarm id and eid"""
Get the plugin object for the specified alarm id and eid
"""
base_obj = _get_base_object(alarm_id) base_obj = _get_base_object(alarm_id)
if len(base_obj.instance_objects): if len(base_obj.instance_objects):
@ -905,9 +883,7 @@ def _get_object(alarm_id, eid):
def _build_entity_id(plugin, plugin_instance): def _build_entity_id(plugin, plugin_instance):
""" """Builds an entity id string based on the collectd notification object"""
Builds an entity id string based on the collectd notification object.
"""
inst_error = False inst_error = False
@ -968,8 +944,6 @@ def _build_entity_id(plugin, plugin_instance):
def _get_df_mountpoints(): def _get_df_mountpoints():
"""
"""
conf_file = PLUGIN_PATH + 'df.conf' conf_file = PLUGIN_PATH + 'df.conf'
if not os.path.exists(conf_file): if not os.path.exists(conf_file):
@ -996,9 +970,7 @@ def _get_df_mountpoints():
def _print_obj(obj): def _print_obj(obj):
""" """Print a single object"""
Print a single object
"""
base_object = False base_object = False
for plugin in PLUGIN_NAME_LIST: for plugin in PLUGIN_NAME_LIST:
if PLUGINS[plugin] == obj: if PLUGINS[plugin] == obj:
@ -1045,9 +1017,7 @@ def _print_obj(obj):
def _print_state(obj=None): def _print_state(obj=None):
""" """Print the current object state"""
Print the current object state
"""
try: try:
objs = [] objs = []
if obj is None: if obj is None:
@ -1069,9 +1039,7 @@ def _print_state(obj=None):
def _database_setup(database): def _database_setup(database):
""" """Setup the influx database for collectd resource samples"""
Setup the influx database for collectd resource samples
"""
collectd.info("%s setting up influxdb:%s database" % collectd.info("%s setting up influxdb:%s database" %
(PLUGIN, database)) (PLUGIN, database))
@ -1144,9 +1112,7 @@ def _database_setup(database):
def _clear_alarm_for_missing_filesystems(): def _clear_alarm_for_missing_filesystems():
""" """Clear alarmed file systems that are no longer mounted or present"""
Clear alarmed file systems that are no longer mounted or present
"""
# get the DF (filesystem plugin) base object. # get the DF (filesystem plugin) base object.
df_base_obj = PLUGINS[PLUGIN__DF] df_base_obj = PLUGINS[PLUGIN__DF]
@ -1187,7 +1153,7 @@ def _clear_alarm_for_missing_filesystems():
# Initialize each plugin object with plugin specific data. # Initialize each plugin object with plugin specific data.
# Query FM for existing alarms and run with that starting state. # Query FM for existing alarms and run with that starting state.
def init_func(): def init_func():
""" Collectd FM Notifier Initialization Function """ """Collectd FM Notifier Initialization Function"""
PluginObject.lock = Lock() PluginObject.lock = Lock()

25
collectd-extensions/src/interface.py
View File

@ -167,7 +167,7 @@ class LinkObject:
# #
################################################################## ##################################################################
def raise_port_alarm(self, network): def raise_port_alarm(self, network):
""" Raise a port alarm """ """Raise a port alarm"""
if self.severity != fm_constants.FM_ALARM_SEVERITY_MAJOR: if self.severity != fm_constants.FM_ALARM_SEVERITY_MAJOR:
@ -201,7 +201,7 @@ class LinkObject:
# #
################################################################## ##################################################################
def clear_port_alarm(self, network): def clear_port_alarm(self, network):
""" Clear a port alarm """ """Clear a port alarm"""
if self.severity != fm_constants.FM_ALARM_SEVERITY_CLEAR: if self.severity != fm_constants.FM_ALARM_SEVERITY_CLEAR:
if manage_alarm(self.name, if manage_alarm(self.name,
@ -269,7 +269,7 @@ class NetworkObject:
# #
################################################################## ##################################################################
def raise_iface_alarm(self, severity): def raise_iface_alarm(self, severity):
""" Raise an interface alarm """ """Raise an interface alarm"""
if severity == fm_constants.FM_ALARM_SEVERITY_CLEAR: if severity == fm_constants.FM_ALARM_SEVERITY_CLEAR:
collectd.error("%s %s raise alarm called with clear severity" % collectd.error("%s %s raise alarm called with clear severity" %
@ -310,7 +310,7 @@ class NetworkObject:
# #
################################################################## ##################################################################
def clear_iface_alarm(self): def clear_iface_alarm(self):
""" Clear an interface alarm """ """Clear an interface alarm"""
if self.severity != fm_constants.FM_ALARM_SEVERITY_CLEAR: if self.severity != fm_constants.FM_ALARM_SEVERITY_CLEAR:
if manage_alarm(self.name, if manage_alarm(self.name,
@ -343,7 +343,6 @@ class NetworkObject:
# #
###################################################################### ######################################################################
def manage_iface_alarm(self): def manage_iface_alarm(self):
""" """
# Single Link Config # Single Link Config
if self.link_two.name is None: if self.link_two.name is None:
if self.link_one.state == LINK_DOWN: if self.link_one.state == LINK_DOWN:
@ -412,7 +411,7 @@ NETWORKS = [NetworkObject(NETWORK_MGMT),
# #
########################################################################## ##########################################################################
def get_timestamp(lmon_time): def get_timestamp(lmon_time):
""" Convert lmon time to fm timestamp time """ """Convert lmon time to fm timestamp time"""
if lmon_time: if lmon_time:
try: try:
@ -428,7 +427,7 @@ def get_timestamp(lmon_time):
def dump_network_info(network): def dump_network_info(network):
""" Log the specified network info """ """Log the specified network info"""
link_one_event_time = datetime.datetime.fromtimestamp( link_one_event_time = datetime.datetime.fromtimestamp(
float(network.link_one.timestamp)).strftime('%Y-%m-%d %H:%M:%S') float(network.link_one.timestamp)).strftime('%Y-%m-%d %H:%M:%S')
@ -479,7 +478,7 @@ def dump_network_info(network):
# #
########################################################################## ##########################################################################
def this_hosts_alarm(hostname, eid): def this_hosts_alarm(hostname, eid):
""" Check if the specified eid is for this host """ """Check if the specified eid is for this host"""
if hostname: if hostname:
if eid: if eid:
@ -527,7 +526,7 @@ def this_hosts_alarm(hostname, eid):
# #
########################################################################## ##########################################################################
def clear_alarms(alarm_id_list): def clear_alarms(alarm_id_list):
""" Clear alarm state of all plugin alarms. """ """Clear alarm state of all plugin alarms"""
found = False found = False
for alarm_id in alarm_id_list: for alarm_id in alarm_id_list:
alarms = api.get_faults_by_id(alarm_id) alarms = api.get_faults_by_id(alarm_id)
@ -575,7 +574,7 @@ def clear_alarms(alarm_id_list):
# #
########################################################################## ##########################################################################
def manage_alarm(name, network, level, action, severity, alarm_id, timestamp): def manage_alarm(name, network, level, action, severity, alarm_id, timestamp):
""" Manage raise and clear of port and interface alarms """ """Manage raise and clear of port and interface alarms"""
ts = datetime.datetime.fromtimestamp( ts = datetime.datetime.fromtimestamp(
float(timestamp)).strftime('%Y-%m-%d %H:%M:%S') float(timestamp)).strftime('%Y-%m-%d %H:%M:%S')
@ -638,7 +637,7 @@ def manage_alarm(name, network, level, action, severity, alarm_id, timestamp):
# The config function - called once on collectd process startup # The config function - called once on collectd process startup
def config_func(config): def config_func(config):
""" Configure the plugin """ """Configure the plugin"""
# Need to update the Link Status Query URL with the port number. # Need to update the Link Status Query URL with the port number.
url_updated = False url_updated = False
@ -696,7 +695,7 @@ def config_func(config):
# The init function - called once on collectd process startup # The init function - called once on collectd process startup
def init_func(): def init_func():
""" Init the plugin """ """Init the plugin"""
if obj.config_done is False: if obj.config_done is False:
collectd.info("%s configuration failed" % PLUGIN) collectd.info("%s configuration failed" % PLUGIN)
@ -716,7 +715,7 @@ def init_func():
# The sample read function - called on every audit interval # The sample read function - called on every audit interval
def read_func(): def read_func():
""" collectd interface monitor plugin read function """ """collectd interface monitor plugin read function"""
if obj.init_done is False: if obj.init_done is False:
init_func() init_func()

6
collectd-extensions/src/memory.py
View File

@ -55,7 +55,7 @@ obj = MEM()
def log_meminfo(plugin, name, meminfo): def log_meminfo(plugin, name, meminfo):
""" Log the supplied meminfo """ """Log the supplied meminfo"""
if debug is False: if debug is False:
return return
@ -76,9 +76,7 @@ def log_meminfo(plugin, name, meminfo):
def config_func(config): def config_func(config):
""" """Configure the memory usage plugin"""
Configure the memory usage plugin
"""
for node in config.children: for node in config.children:
key = node.key.lower() key = node.key.lower()

28
collectd-extensions/src/mtce_notifier.py
View File

@ -79,9 +79,7 @@ PLUGIN__EXAMPLE = 'example'
class collectdMtceNotifierObject: class collectdMtceNotifierObject:
def __init__(self, port): def __init__(self, port):
""" """collectdMtceNotifierObject Class constructor"""
collectdMtceNotifierObject Class constructor
"""
# default maintenance port # default maintenance port
self.port = port self.port = port
self.addr = None self.addr = None
@ -119,9 +117,7 @@ obj = collectdMtceNotifierObject(MTCE_CMD_RX_PORT)
def _get_active_controller_ip(): def _get_active_controller_ip():
""" """Get the active controller host IP"""
Get the active controller host IP
"""
try: try:
obj.addr = socket.getaddrinfo('controller', None)[0][4][0] obj.addr = socket.getaddrinfo('controller', None)[0][4][0]
@ -134,9 +130,7 @@ def _get_active_controller_ip():
def _df_instance_to_path(df_inst): def _df_instance_to_path(df_inst):
""" """Convert a df instance name to a mountpoint"""
Convert a df instance name to a mountpoint
"""
# df_root is not a dynamic file system. Ignore that one. # df_root is not a dynamic file system. Ignore that one.
if df_inst == 'df_root': if df_inst == 'df_root':
@ -148,9 +142,7 @@ def _df_instance_to_path(df_inst):
# This function removes degraded file systems that are no longer present. # This function removes degraded file systems that are no longer present.
def _clear_degrade_for_missing_filesystems(): def _clear_degrade_for_missing_filesystems():
""" """Remove degraded file systems that are no longer mounted or present"""
Remove degraded file systems that are no longer mounted or present.
"""
for df_inst in obj.degrade_list: for df_inst in obj.degrade_list:
@ -178,9 +170,7 @@ def _clear_degrade_for_missing_filesystems():
# val = port number # val = port number
# #
def config_func(config): def config_func(config):
""" """Configure the maintenance degrade notifier plugin"""
Configure the maintenance degrade notifier plugin.
"""
collectd.debug('%s config function' % PLUGIN) collectd.debug('%s config function' % PLUGIN)
for node in config.children: for node in config.children:
@ -200,9 +190,7 @@ def config_func(config):
# Collectd calls this function on startup. # Collectd calls this function on startup.
def init_func(): def init_func():
""" """Collectd Mtce Notifier Initialization Function"""
Collectd Mtce Notifier Initialization Function
"""
obj.host = os.uname()[1] obj.host = os.uname()[1]
collectd.info("%s %s:%s sending to mtce port %d" % collectd.info("%s %s:%s sending to mtce port %d" %
@ -221,9 +209,7 @@ def init_func():
# 4. send mtcAgent the degrade state message. # 4. send mtcAgent the degrade state message.
# #
def notifier_func(nObject): def notifier_func(nObject):
""" """Collectd Mtce Notifier Handler Function"""
Collectd Mtce Notifier Handler Function
"""
# Create the resource name from the notifier object. # Create the resource name from the notifier object.
# format: <plugin name>_<plugin_instance_name> # format: <plugin name>_<plugin_instance_name>

23
collectd-extensions/src/ntpq.py
View File

@ -114,7 +114,7 @@ obj = NtpqObject()
############################################################################### ###############################################################################
def _add_unreachable_server(ip=None): def _add_unreachable_server(ip=None):
""" Add ip to unreachable_servers list """ """Add ip to unreachable_servers list"""
if ip: if ip:
if ip not in obj.unreachable_servers: if ip not in obj.unreachable_servers:
@ -153,7 +153,7 @@ def _add_unreachable_server(ip=None):
############################################################################### ###############################################################################
def _raise_alarm(ip=None): def _raise_alarm(ip=None):
""" Assert an NTP alarm """ """Assert an NTP alarm"""
if not ip: if not ip:
# Don't re-raise the alarm if its already raised # Don't re-raise the alarm if its already raised
@ -221,7 +221,7 @@ def _raise_alarm(ip=None):
############################################################################### ###############################################################################
def _clear_base_alarm(): def _clear_base_alarm():
""" Clear the NTP base alarm """ """Clear the NTP base alarm"""
if api.clear_fault(PLUGIN_ALARMID, obj.base_eid) is False: if api.clear_fault(PLUGIN_ALARMID, obj.base_eid) is False:
collectd.error("%s failed to clear alarm %s:%s" % collectd.error("%s failed to clear alarm %s:%s" %
@ -254,10 +254,7 @@ def _clear_base_alarm():
############################################################################### ###############################################################################
def _remove_ip_from_unreachable_list(ip): def _remove_ip_from_unreachable_list(ip):
""" """Remove an IP address from the unreachable list and clear its NTP alarms"""
Remove an IP address from the unreachable list and
clear any NTP alarm that might be asserted for it.
"""
# remove from unreachable list if its there # remove from unreachable list if its there
if ip and ip in obj.unreachable_servers: if ip and ip in obj.unreachable_servers:
@ -299,7 +296,7 @@ def _remove_ip_from_unreachable_list(ip):
############################################################################### ###############################################################################
def _add_ip_to_ntpq_server_list(ip): def _add_ip_to_ntpq_server_list(ip):
""" Add this IP to the list of servers that ntpq reports against. """ """Add this IP to the list of servers that ntpq reports against"""
if ip not in obj.server_list_ntpq: if ip not in obj.server_list_ntpq:
obj.server_list_ntpq.append(ip) obj.server_list_ntpq.append(ip)
@ -321,7 +318,7 @@ def _add_ip_to_ntpq_server_list(ip):
############################################################################### ###############################################################################
def _cleanup_stale_servers(): def _cleanup_stale_servers():
""" Cleanup the server IP tracking lists """ """Cleanup the server IP tracking lists"""
collectd.debug("%s CLEANUP REACHABLE: %s %s" % collectd.debug("%s CLEANUP REACHABLE: %s %s" %
(PLUGIN, obj.server_list_ntpq, obj.reachable_servers)) (PLUGIN, obj.server_list_ntpq, obj.reachable_servers))
@ -356,7 +353,7 @@ def _cleanup_stale_servers():
############################################################################### ###############################################################################
def _get_ntp_servers(): def _get_ntp_servers():
""" Read the provisioned servers from the ntp conf file """ """Read the provisioned servers from the ntp conf file"""
with open(PLUGIN_CONF, 'r') as infile: with open(PLUGIN_CONF, 'r') as infile:
for line in infile: for line in infile:
@ -401,7 +398,7 @@ def _get_ntp_servers():
############################################################################### ###############################################################################
def _is_controller(ip): def _is_controller(ip):
""" Returns True if this IP corresponds to one of the controllers """ """Returns True if this IP corresponds to one of the controllers"""
collectd.debug("%s check if '%s' is a controller ip" % (PLUGIN, ip)) collectd.debug("%s check if '%s' is a controller ip" % (PLUGIN, ip))
with open('/etc/hosts', 'r') as infile: with open('/etc/hosts', 'r') as infile:
@ -433,7 +430,7 @@ def _is_controller(ip):
############################################################################### ###############################################################################
def _is_uuid_like(val): def _is_uuid_like(val):
"""Returns validation of a value as a UUID.""" """Returns validation of a value as a UUID"""
try: try:
return str(uuid.UUID(val)) == val return str(uuid.UUID(val)) == val
except (TypeError, ValueError, AttributeError): except (TypeError, ValueError, AttributeError):
@ -459,7 +456,7 @@ def _is_uuid_like(val):
############################################################################### ###############################################################################
def config_func(config): def config_func(config):
""" Configure the plugin """ """Configure the plugin"""
collectd.debug('%s config function' % PLUGIN) collectd.debug('%s config function' % PLUGIN)
return 0 return 0

14
collectd-extensions/src/plugin_common.py
View File

@ -89,7 +89,7 @@ class PluginObject(object):
########################################################################### ###########################################################################
def init_ready(self): def init_ready(self):
""" Test for system init ready state """ """Test for system init ready state"""
if os.path.exists(tsc.INITIAL_CONFIG_COMPLETE_FLAG) is False: if os.path.exists(tsc.INITIAL_CONFIG_COMPLETE_FLAG) is False:
self.log_throttle_count += 1 self.log_throttle_count += 1
@ -117,7 +117,7 @@ class PluginObject(object):
# #
########################################################################### ###########################################################################
def gethostname(self): def gethostname(self):
""" Fetch the hostname """ """Fetch the hostname"""
# get current hostname # get current hostname
try: try:
@ -142,7 +142,7 @@ class PluginObject(object):
# #
########################################################################### ###########################################################################
def is_virtual(self): def is_virtual(self):
""" Check for virtual host """ """Check for virtual host"""
try: try:
cmd = '/usr/bin/facter is_virtual' cmd = '/usr/bin/facter is_virtual'
@ -185,7 +185,7 @@ class PluginObject(object):
# #
########################################################################### ###########################################################################
def check_for_fit(self, name, unit): def check_for_fit(self, name, unit):
""" Load FIT data into usage if it exists """ """Load FIT data into usage if it exists"""
fit_file = '/var/run/fit/' + name + '_data' fit_file = '/var/run/fit/' + name + '_data'
@ -241,7 +241,7 @@ class PluginObject(object):
# #
########################################################################### ###########################################################################
def make_http_request(self, url=None, to=None, hdrs=None): def make_http_request(self, url=None, to=None, hdrs=None):
""" Make a blocking HTTP Request and return result """ """Make a blocking HTTP Request and return result"""
try: try:
@ -280,7 +280,7 @@ class PluginObject(object):
def is_uuid_like(val): def is_uuid_like(val):
"""Returns validation of a value as a UUID. """Returns validation of a value as a UUID
For our purposes, a UUID is a canonical form string: For our purposes, a UUID is a canonical form string:
aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
@ -292,7 +292,7 @@ def is_uuid_like(val):
def get_severity_str(severity): def get_severity_str(severity):
""" get string that represents the specified severity """ """get string that represents the specified severity"""
if severity == fm_constants.FM_ALARM_SEVERITY_CLEAR: if severity == fm_constants.FM_ALARM_SEVERITY_CLEAR:
return "clear" return "clear"

12
collectd-extensions/src/ptp.py
View File

@ -236,7 +236,7 @@ TIMESTAMP_MODE__LEGACY = 'legacy'
# #
##################################################################### #####################################################################
def _get_supported_modes(interface): def _get_supported_modes(interface):
""" Get the supported modes for the specified interface """ """Get the supported modes for the specified interface"""
hw_tx = hw_rx = sw_tx = sw_rx = False hw_tx = hw_rx = sw_tx = sw_rx = False
modes = [] modes = []
@ -299,7 +299,7 @@ def _get_supported_modes(interface):
# #
##################################################################### #####################################################################
def get_alarm_object(alarm, interface=None): def get_alarm_object(alarm, interface=None):
""" Alarm object lookup """ """Alarm object lookup"""
for o in ALARM_OBJ_LIST: for o in ALARM_OBJ_LIST:
# print_alarm_object(o) # print_alarm_object(o)
@ -329,7 +329,7 @@ def get_alarm_object(alarm, interface=None):
# #
##################################################################### #####################################################################
def clear_alarm(eid): def clear_alarm(eid):
""" Clear the ptp alarm with the specified entity ID """ """Clear the ptp alarm with the specified entity ID"""
try: try:
if api.clear_fault(PLUGIN_ALARMID, eid) is True: if api.clear_fault(PLUGIN_ALARMID, eid) is True:
@ -364,7 +364,7 @@ def clear_alarm(eid):
# #
##################################################################### #####################################################################
def raise_alarm(alarm_cause, interface=None, data=0): def raise_alarm(alarm_cause, interface=None, data=0):
""" Assert a cause based PTP alarm """ """Assert a cause based PTP alarm"""
collectd.debug("%s Raising Alarm %d" % (PLUGIN, alarm_cause)) collectd.debug("%s Raising Alarm %d" % (PLUGIN, alarm_cause))
@ -461,7 +461,7 @@ def raise_alarm(alarm_cause, interface=None, data=0):
# #
##################################################################### #####################################################################
def create_interface_alarm_objects(interface=None): def create_interface_alarm_objects(interface=None):
""" Create alarm objects """ """Create alarm objects"""
collectd.debug("%s Alarm Object Create: Interface:%s " % collectd.debug("%s Alarm Object Create: Interface:%s " %
(PLUGIN, interface)) (PLUGIN, interface))
@ -548,7 +548,7 @@ def create_interface_alarm_objects(interface=None):
# #
##################################################################### #####################################################################
def read_timestamp_mode(): def read_timestamp_mode():
""" Load timestamping mode """ """Load timestamping mode"""
if os.path.exists(PLUGIN_CONF_FILE): if os.path.exists(PLUGIN_CONF_FILE):
current_mode = obj.mode current_mode = obj.mode

10
collectd-extensions/src/remotels.py
View File

@ -70,7 +70,7 @@ obj = pc.PluginObject(PLUGIN, "")
# Raise Remote Logging Server Alarm # Raise Remote Logging Server Alarm
def raise_alarm(): def raise_alarm():
""" Raise Remote Logging Server Alarm. """ """Raise Remote Logging Server Alarm"""
repair = 'Ensure Remote Log Server IP is reachable from ' repair = 'Ensure Remote Log Server IP is reachable from '
repair += 'Controller through OAM interface; otherwise ' repair += 'Controller through OAM interface; otherwise '
@ -110,7 +110,7 @@ def raise_alarm():
# Clear remote logging server alarm # Clear remote logging server alarm
def clear_alarm(): def clear_alarm():
""" Clear remote logging server alarm """ """Clear remote logging server alarm"""
try: try:
if api.clear_fault(PLUGIN_ALARMID, obj.base_eid) is True: if api.clear_fault(PLUGIN_ALARMID, obj.base_eid) is True:
@ -126,7 +126,7 @@ def clear_alarm():
# The config function - called once on collectd process startup # The config function - called once on collectd process startup
def config_func(config): def config_func(config):
""" Configure the plugin """ """Configure the plugin"""
# all configuration is learned during normal monitoring # all configuration is learned during normal monitoring
obj.config_done = True obj.config_done = True
@ -135,7 +135,7 @@ def config_func(config):
# The init function - called once on collectd process startup # The init function - called once on collectd process startup
def init_func(): def init_func():
""" Init the plugin """ """Init the plugin"""
# remote logging server monitoring is for controllers only # remote logging server monitoring is for controllers only
if tsc.nodetype != 'controller': if tsc.nodetype != 'controller':
@ -155,7 +155,7 @@ def init_func():
# The sample read function - called on every audit interval # The sample read function - called on every audit interval
def read_func(): def read_func():
""" Remote logging server connectivity plugin read function """ """Remote logging server connectivity plugin read function"""
# remote logging server monitoring is for controllers only # remote logging server monitoring is for controllers only
if tsc.nodetype != 'controller': if tsc.nodetype != 'controller':

88
vm-topology/vm-topology/vm_topology/exec/vm_topology.py
View File

@ -107,14 +107,15 @@ LIBVIRT_REAP_SEC = LIBVIRT_TIMEOUT_SEC + 2.0
# Define a context manager to suppress stdout and stderr. # Define a context manager to suppress stdout and stderr.
class suppress_stdout_stderr(object): class suppress_stdout_stderr(object):
''' """Context manager for doing a "deep suppression" of stdout and stderr
A context manager for doing a "deep suppression" of stdout and stderr in
Python, i.e. will suppress all print, even if the print originates in a i.e. will suppress all print, even if the print originates in a
compiled C/Fortran sub-function. compiled C/Fortran sub-function.
This will not suppress raised exceptions, since exceptions are printed
This will not suppress raised exceptions, since exceptions are printed
to stderr just before a script exits, and after the context manager has to stderr just before a script exits, and after the context manager has
exited (at least, I think that is why it lets exceptions through). exited (at least, I think that is why it lets exceptions through).
''' """
def __init__(self): def __init__(self):
# Open a pair of null files # Open a pair of null files
self.null_fds = [os.open(os.devnull, os.O_RDWR) for x in range(2)] self.null_fds = [os.open(os.devnull, os.O_RDWR) for x in range(2)]
@ -140,9 +141,7 @@ def atoi(text):
def natural_keys(text): def natural_keys(text):
''' """alist.sort(key=natural_keys) sorts in human order"""
alist.sort(key=natural_keys) sorts in human order
'''
return [atoi(c) for c in re.split('(\d+)', text)] return [atoi(c) for c in re.split('(\d+)', text)]
@ -253,6 +252,7 @@ def help_text_epilog():
class ChoiceOpt(cfg.Opt): class ChoiceOpt(cfg.Opt):
r"""Option with List(String) type r"""Option with List(String) type
Option with ``type`` :class:`oslo_config.types.List` Option with ``type`` :class:`oslo_config.types.List`
:param name: the option's name :param name: the option's name
:param choices: Optional sequence of either valid values or tuples of valid :param choices: Optional sequence of either valid values or tuples of valid
@ -269,9 +269,7 @@ class ChoiceOpt(cfg.Opt):
def parse_arguments(debug, show): def parse_arguments(debug, show):
""" """Parse command line arguments"""
Parse command line arguments.
"""
# Initialize all debug flags to False # Initialize all debug flags to False
define_debug_flags(debug) define_debug_flags(debug)
@ -357,7 +355,7 @@ def parse_arguments(debug, show):
def configure_logging(logger, level=logging.DEBUG): def configure_logging(logger, level=logging.DEBUG):
""" Configure logger streams and format. """ """Configure logger streams and format"""
logger.setLevel(level) logger.setLevel(level)
ch = logging.StreamHandler(sys.stdout) ch = logging.StreamHandler(sys.stdout)
ch.setLevel(level) ch.setLevel(level)
@ -368,8 +366,10 @@ def configure_logging(logger, level=logging.DEBUG):
def _translate_keys(collection, convert): def _translate_keys(collection, convert):
""" For a collection of elements, translate _info field names """translate elements _info field names into human-readable names
into human-readable names based on a list of conversion tuples.
:param collection: dictionary containing the elements to be translated
:param convert: list of conversion tuples
""" """
for k, item in collection.items(): for k, item in collection.items():
keys = list(item.__dict__.keys()) keys = list(item.__dict__.keys())
@ -384,7 +384,7 @@ def _translate_keys(collection, convert):
def _translate_extended_states(collection): def _translate_extended_states(collection):
""" Return human readable power-state string. """ """Return human readable power-state string"""
power_states = [ power_states = [
'NOSTATE', # 0x00 'NOSTATE', # 0x00
'Running', # 0x01 'Running', # 0x01
@ -408,7 +408,7 @@ def _translate_extended_states(collection):
def _translate_virDomainState(state): def _translate_virDomainState(state):
""" Return human readable virtual domain state string. """ """Return human readable virtual domain state string"""
states = {} states = {}
states[0] = 'NOSTATE' states[0] = 'NOSTATE'
states[1] = 'Running' states[1] = 'Running'
@ -423,7 +423,7 @@ def _translate_virDomainState(state):
def _translate_virVcpuState(state): def _translate_virVcpuState(state):
""" Return human readable virtual vpu state string. """ """Return human readable virtual vpu state string"""
states = {} states = {}
states[0] = 'Offline' states[0] = 'Offline'
states[1] = 'Running' states[1] = 'Running'
@ -433,7 +433,7 @@ def _translate_virVcpuState(state):
def _mask_to_cpulist(mask=0): def _mask_to_cpulist(mask=0):
""" Create cpulist from mask, list in socket-core-thread enumerated order. """Create cpulist from mask, list in socket-core-thread enumerated order
:param extended: extended info :param extended: extended info
:param mask: cpuset mask :param mask: cpuset mask
@ -452,11 +452,11 @@ def _mask_to_cpulist(mask=0):
def string_to_cpulist(cpus_str=''): def string_to_cpulist(cpus_str=''):
''' Convert a string representation to cpulist """Convert a string representation to cpulist
:param cpus_str: string containing list cpus, eg., 1,2,6-7 :param cpus_str: string containing list cpus, eg., 1,2,6-7
:returns cpulist :returns cpulist
''' """
# Create list of excluded cpus by parsing excluded_cpulist_str, # Create list of excluded cpus by parsing excluded_cpulist_str,
# example: 1,2,6-7 # example: 1,2,6-7
@ -480,8 +480,9 @@ def string_to_cpulist(cpus_str=''):
def list_to_range(L=None): def list_to_range(L=None):
""" Convert a list into a string of comma separate ranges. """Convert a list into a string of comma separate ranges
E.g., [1,2,3,8,9,15] is converted to '1-3,8-9,15'
E.g., [1,2,3,8,9,15] is converted to '1-3,8-9,15'
""" """
if L is None: if L is None:
L = [] L = []
@ -491,8 +492,9 @@ def list_to_range(L=None):
def range_to_list(csv_range=None): def range_to_list(csv_range=None):
""" Convert a string of comma separate ranges into an expanded list of """Convert a string of comma separate ranges into an expanded list of ints
integers. E.g., '1-3,8-9,15' is converted to [1,2,3,8,9,15]
E.g., '1-3,8-9,15' is converted to [1,2,3,8,9,15]
""" """
if not csv_range: if not csv_range:
return [] return []
@ -525,9 +527,9 @@ def libvirt_domain_info_worker(tuple_hosts):
def do_libvirt_domain_info(tuple_hosts): def do_libvirt_domain_info(tuple_hosts):
""" """Connect to libvirt for specified host, and retrieve per-domain information
Connect to libvirt for specified host, and retrieve per-domain information
including cpu affinity per vcpu. The information includes cpu affinity per vcpu.
""" """
(host) = tuple_hosts (host) = tuple_hosts
domains = {} domains = {}
@ -683,9 +685,7 @@ def print_debug_info(tenants=None, regions=None,
topologies=None, topologies_idx=None, topologies_sib=None, topologies=None, topologies_idx=None, topologies_sib=None,
computes_cell=None, computes_cell=None,
debug=None, show=None): debug=None, show=None):
""" """Print debug information - pretty formatting of various data structures"""
Print debug information - pretty formatting of various data structures
"""
pp = pprint.PrettyPrinter(indent=2) pp = pprint.PrettyPrinter(indent=2)
if True in debug.values(): if True in debug.values():
@ -779,7 +779,7 @@ def print_debug_info(tenants=None, regions=None,
def define_debug_flags(debug): def define_debug_flags(debug):
""" Define dictionary of debug flags. """ """Define dictionary of debug flags"""
opts = ['all', opts = ['all',
'creds', 'creds',
'hypervisors', 'hypervisors',
@ -800,7 +800,7 @@ def define_debug_flags(debug):
def define_options(): def define_options():
""" Define several groupings with lists of show options. """ """Define several groupings with lists of show options"""
L_opts = ['brief', L_opts = ['brief',
'all', 'all',
] ]
@ -826,7 +826,7 @@ def define_options():
def define_option_flags(show, options=None, def define_option_flags(show, options=None,
L_opts=None, L_brief=None, L_details=None, L_other=None): L_opts=None, L_brief=None, L_details=None, L_other=None):
""" Define dictionary of option flags. """ """Define dictionary of option flags"""
if options is None: if options is None:
options = [] options = []
if L_opts is None: if L_opts is None:
@ -864,8 +864,7 @@ def print_all_tables(tenants=None,
images_in_use=None, images_in_use=None,
server_groups_in_use=None, server_groups_in_use=None,
debug=None, show=None): debug=None, show=None):
""" Print all summary tables using PrettyTable. """Print all summary tables using PrettyTable"""
"""
# Print list of aggregates # Print list of aggregates
if show['aggregates']: if show['aggregates']:
print() print()
@ -1413,8 +1412,7 @@ def print_all_tables(tenants=None,
def _get_host_id(tenant_id=None, host_name=None): def _get_host_id(tenant_id=None, host_name=None):
""" Routine defined in nova/api/openstack/compute/views/servers.py . """Routine defined in nova/api/openstack/compute/views/servers.py"""
"""
sha_hash = hashlib.sha224(tenant_id + host_name) sha_hash = hashlib.sha224(tenant_id + host_name)
return sha_hash.hexdigest() return sha_hash.hexdigest()
@ -1425,15 +1423,15 @@ def start_process():
def get_info_and_display(show=None): def get_info_and_display(show=None):
""" Get information from various sources (keystone, nova, libvirt). """Get information from various sources (keystone, nova, libvirt)
Display the following information in table format. Display the following information in table format.
- nova view of hypervisors and servers - nova view of hypervisors and servers
- libvirt view of servers - libvirt view of servers
- nova view of in-progress migrations - nova view of in-progress migrations
- nova view of flavors in-use - nova view of flavors in-use
- nova view of volumes and images in-use - nova view of volumes and images in-use
- nova view of server-groups in-use - nova view of server-groups in-use
""" """
# Keep track of mismatches found when validating data sources # Keep track of mismatches found when validating data sources