openstack
/
monasca-agent
Code Issues Proposed changes

OVS: Verify found configuration file 

OVS autodetection relies on reading configuration
file 'neutron.conf' and having specific sections inside.
One of them 'keystone_authtoken' is mandatory to be found.
Added check to verify if supplied/found file meets that
requirement. If not, plugin exits.

Note:
    As it turns out, neutron configuration schema
    is quite broad and configuration can be loaded
    from several configuration files located in,
    for example, /etc/neutron/neutron.conf.d/ or /etc/.
    Effectively that means that every section,
    that OVS plugin tries access, might be located
    in different file.

Story: 2000956
Task: 4087
Change-Id: I5564aa54337c240d12bd91cca7bf2d06ced51bfa
This commit is contained in:
Tomasz Trębski 2017-03-30 12:54:34 +02:00
parent 1aeddf955b
commit 7fdb297fe7
2 changed files with 76 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
monasca_setup/detection/plugins/ovs.py
View File

@ -3,11 +3,11 @@
import ConfigParser
import logging
import os
import psutil
import re
import monasca_setup.agent_config
import monasca_setup.detection
from monasca_setup import agent_config
from monasca_setup import detection
from monasca_setup.detection import utils
log = logging.getLogger(__name__)
@ -44,34 +44,69 @@ ignorable_args = ['admin_user', 'admin_password', 'admin_tenant_name',
uri_version_re = re.compile('.*v2.0|.*v3.0|.*v1|.*v2')
class Ovs(monasca_setup.detection.Plugin):
class Ovs(detection.Plugin):
"""Detect OVS daemons and setup configuration to monitor
"""
PROC_NAME = 'neutron-openvsw'
"""Name of the ovs process to look for"""
REQUIRED_CONF_SECTIONS = 'keystone_authtoken',
"""Tuple of sections that must be part of neutron configuration file"""
def _detect(self):
process_exist = (monasca_setup.detection.
find_process_cmdline('neutron-openvsw'))
process_exist = utils.find_process_cmdline(Ovs.PROC_NAME)
has_dependencies = self.dependencies_installed()
neutron_conf = self.get_ovs_config_file() if process_exist else ''
neutron_conf = self._get_ovs_config_file() if process_exist else ''
neutron_conf_exists = os.path.isfile(neutron_conf)
neutron_conf_valid = (neutron_conf_exists
and self._is_neutron_conf_valid(neutron_conf))
self.available = (process_exist is not None and
os.path.isfile(neutron_conf) and has_dependencies)
neutron_conf_valid and has_dependencies)
if not self.available:
if not process_exist:
log.error('OVS daemon process does not exist.')
elif not neutron_conf:
log.error('OVS daemon process [%s] does not exist.',
Ovs.PROC_NAME)
elif not neutron_conf_exists:
log.error(('OVS daemon process exists but configuration '
'file was not found. Path to file does not exist '
'as a process parameter or was not '
'passed via args.'))
elif not neutron_conf_valid:
log.error(('OVS daemon process exists, configuration file was '
'found but it looks like it does not contain '
'one of following sections=%s. '
'Check if neutron was not configured to load '
'configuration from /etc/neutron/neutron.conf.d/.'),
Ovs.REQUIRED_CONF_SECTIONS)
# NOTE(trebskit) the problem with that approach is that
# each setting that Ovs plugin require might be scattered
# through multiple files located inside
# /etc/neutron/neutron.conf.d/
# not to mention that it is still possible to have
# yet another configuration file passed as neutron CLI
# argument
elif not has_dependencies:
log.error(('OVS daemon process exists but required '
'dependence python-neutronclient is '
'not installed.'))
else:
log.info("\tUsing neutron configuration file {0}".format(
neutron_conf))
self.neutron_conf = neutron_conf
def get_ovs_config_file(self):
def _is_neutron_conf_valid(self, conf_file):
neutron_cfg = ConfigParser.SafeConfigParser()
neutron_cfg.read(conf_file)
for section in self.REQUIRED_CONF_SECTIONS:
if not neutron_cfg.has_section(section=section):
return False
return True
def _get_ovs_config_file(self):
neutron_conf = None
if self.args:
for arg in self.args:
@ -81,36 +116,26 @@ class Ovs(monasca_setup.detection.Plugin):
# Walk through the list of processes, searching for 'neutron'
# process with 'neutron.conf' inside one of the parameters.
if not neutron_conf:
for proc in psutil.process_iter():
try:
proc_dict = proc.as_dict()
if proc_dict['name'] == 'neutron-openvsw':
cmd = proc_dict['cmdline']
neutron_config_params = [param for param in cmd if
'neutron.conf' in param]
if not neutron_config_params:
continue
if '=' in neutron_config_params[0]:
neutron_conf = neutron_config_params[0].split('=')[
1]
else:
neutron_conf = neutron_config_params[0]
except (IOError, psutil.NoSuchProcess):
# Process has already terminated, ignore
continue
proc = utils.find_process_name(Ovs.PROC_NAME)
proc_dict = proc.as_dict(attrs=['cmdline'])
cmd = proc_dict['cmdline']
neutron_config_params = [param for param in cmd if
'neutron.conf' in param]
if neutron_config_params:
if '=' in neutron_config_params[0]:
neutron_conf = neutron_config_params[0].split('=')[1]
else:
neutron_conf = neutron_config_params[0]
return neutron_conf
def build_config(self):
"""Build the config as a Plugins object and return.
"""
config = monasca_setup.agent_config.Plugins()
config = agent_config.Plugins()
neutron_cfg = ConfigParser.SafeConfigParser()
log.info("\tUsing neutron configuration file {0}".format(self.neutron_conf))
log.info("\tUsing neutron configuration file %s", self.neutron_conf)
neutron_cfg.read(self.neutron_conf)
cfg_needed = {'admin_user': 'admin_user',
'admin_password': 'admin_password',
'admin_tenant_name': 'admin_tenant_name'}
cfg_section = 'keystone_authtoken'
# Handle Devstack's slightly different neutron.conf names
@ -121,6 +146,10 @@ class Ovs(monasca_setup.detection.Plugin):
cfg_needed = {'admin_user': 'username',
'admin_password': 'password',
'admin_tenant_name': 'project_name'}
else:
cfg_needed = {'admin_user': 'admin_user',
'admin_password': 'admin_password',
'admin_tenant_name': 'admin_tenant_name'}
# Start with plugin-specific configuration parameters
init_config = {'cache_dir': cache_dir,

19
tests/detection/test_ovs.py
View File

@ -43,7 +43,7 @@ class TestOvs(unittest.TestCase):
'http://10.10.10.10', 'region1']
self.assertTrue(mock_detect.called)
def _detect(self, ovs_obj):
def _detect(self, ovs_obj, file_config_valid=True):
ovs_obj.neutron_conf = None
ovs_obj.available = False
with contextlib.nested(
@ -51,8 +51,10 @@ class TestOvs(unittest.TestCase):
return_value=[ps_util_get_proc()]),
patch.object(os.path, 'isfile', return_value=True),
patch.object(ovs_obj, 'dependencies_installed',
return_value=True)) as (
mock_process_iter, mock_isfile, dependencies):
return_value=True),
patch.object(ovs_obj, '_is_neutron_conf_valid',
return_value=file_config_valid)) as (
mock_process_iter, mock_isfile, dependencies, _):
ovs_obj._detect()
self.assertTrue(mock_process_iter.called)
if not ps_util_get_proc.cmdLine:
@ -133,6 +135,11 @@ class TestOvs(unittest.TestCase):
self.assertEqual(self.ovs_obj.neutron_conf,
'/etc/neutron/neutron.conf')
def test_detect_invalid_config_file(self):
self._detect(self.ovs_obj, file_config_valid=False)
self.assertFalse(self.ovs_obj.available)
self.assertIsNone(self.ovs_obj.neutron_conf)
def test_detect_devstack(self):
ps_util_get_proc.cmdLine = ['--config-file=/opt/stack/neutron.conf']
self._detect(self.ovs_obj)
@ -144,7 +151,7 @@ class TestOvs(unittest.TestCase):
ps_util_get_proc.detect_warning = True
self._detect(self.ovs_obj)
self.assertFalse(self.ovs_obj.available)
self.assertEqual(self.ovs_obj.neutron_conf, None)
self.assertIsNone(self.ovs_obj.neutron_conf)
self.assertTrue(mock_log_warn.called)
def test_detect_conf_file_path_given(self):
@ -155,8 +162,10 @@ class TestOvs(unittest.TestCase):
return_value=[ps_util_get_proc()]),
patch.object(os.path, 'isfile', return_value=True),
patch.object(self.ovs_obj, 'dependencies_installed',
return_value=True),
patch.object(self.ovs_obj, '_is_neutron_conf_valid',
return_value=True)) as (
mock_process_iter, mock_isfile, dependencies):
mock_process_iter, mock_isfile, dependencies, _):
self.ovs_obj._detect()
self.assertTrue(mock_isfile.called)
self.assertTrue(self.ovs_obj.available)