Merge lp:~openstack-charmers/charm-helpers/snabbswitch into lp:charm-helpers

[Edward Hope-Morley]

[lp:~openstack-charmers/charm-helpers/snabbswitch]

209. By Edward Hope-Morley on 2014-11-28

synced charm-helpers

210. By Edward Hope-Morley on 2015-02-05

synced lp:charm-helpers

211. By Edward Hope-Morley on 2015-04-12

synced trunk

212. By Edward Hope-Morley on 2015-05-07

synced lp:charm-helpers

213. By Edward Hope-Morley on 2015-05-08

synced lp:charm-helpers

214. By Edward Hope-Morley on 2015-05-11

zones config file

215. By Edward Hope-Morley on 2015-05-11

config name change

216. By Edward Hope-Morley on 2015-05-11

remove bz2 dep on snabbswitch-zones

217. By Edward Hope-Morley on 2015-05-13

Added log when unknown plugin provided to NeutronContext

218. By Edward Hope-Morley on 2015-05-13

added missing neutron_plugin attr to snabb ctxt

219. By Edward Hope-Morley on 2015-05-13

protect against neutron not installed

220. By Edward Hope-Morley on 2015-05-14

removed bad docstring

221. By Edward Hope-Morley on 2015-05-15

.

222. By Edward Hope-Morley on 2015-05-15

use ml2_conf.ini for snabb

223. By Edward Hope-Morley on 2015-05-15

sync /next

224. By Edward Hope-Morley on 2015-05-29

add support for conffiles dir

225. By Edward Hope-Morley on 2015-05-29

add support for conffiles dir

226. By Edward Hope-Morley on 2015-10-23

synced lp:charm-helpers

Unmerged revisions

226. By Edward Hope-Morley on 2015-10-23

synced lp:charm-helpers

225. By Edward Hope-Morley on 2015-05-29

add support for conffiles dir

224. By Edward Hope-Morley on 2015-05-29

add support for conffiles dir

223. By Edward Hope-Morley on 2015-05-15

sync /next

222. By Edward Hope-Morley on 2015-05-15

use ml2_conf.ini for snabb

221. By Edward Hope-Morley on 2015-05-15

.

220. By Edward Hope-Morley on 2015-05-14

removed bad docstring

219. By Edward Hope-Morley on 2015-05-13

protect against neutron not installed

218. By Edward Hope-Morley on 2015-05-13

added missing neutron_plugin attr to snabb ctxt

217. By Edward Hope-Morley on 2015-05-13

Added log when unknown plugin provided to NeutronContext

=== modified file 'charmhelpers/contrib/openstack/context.py'
--- charmhelpers/contrib/openstack/context.py	2015-10-07 21:51:23 +0000
+++ charmhelpers/contrib/openstack/context.py	2015-10-23 09:05:27 +0000
@@ -14,11 +14,15 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
 
+import bz2
 import glob
 import json
 import os
+import base64
 import re
 import time
+import pwd
+
 from base64 import b64decode
 from subprocess import check_call
 
@@ -819,6 +823,8 @@
 
 class NeutronContext(OSContextGenerator):
     interfaces = []
+    SNABBSWITCH_ML2_ZONES_FILE = '/etc/snabbswitch/ml2_zones.txt'
+    CONFFILES_DIR = 'conffiles'
 
     @property
     def plugin(self):
@@ -912,6 +918,74 @@
 
         return n1kv_ctxt
 
+    def _snabb_init_zones_file(self, zones_file):
+        log("Configuring zones file '%s'" % (zones_file), level=INFO)
+        dirname = os.path.dirname(zones_file)
+        if dirname and not os.path.isdir(dirname):
+            os.makedirs(dirname)
+
+        conffile_occurences = 0
+        if os.path.isdir(self.CONFFILES_DIR):
+            fname = os.path.basename(zones_file)
+            for conf in glob.glob("%s/%s*" % (self.CONFFILES_DIR, fname)):
+                if conffile_occurences:
+                    log("Found more than one occurence of %s in %s*" %
+                        (fname, self.CONFFILES_DIR), level=INFO)
+
+                conffile_occurences += 1
+                # First attempt to treat the file as bz2, falling back to raw
+                try:
+                    data = bz2.BZ2File(conf).read()
+                except IOError:
+                    with open(conf, 'r') as fd:
+                        data = fd.read()
+
+                with open(zones_file, 'w') as fd:
+                    fd.write(str(data))
+
+        if not conffile_occurences:
+            encoded_defs = config('snabbswitch-zones')
+            if encoded_defs:
+                out = base64.b64decode(encoded_defs)
+                with open(zones_file, 'w') as fd:
+                    fd.write(out.decode('ascii'))
+
+                log("Updated snabbswitch zones file '%s'" % (zones_file),
+                    level=INFO)
+            else:
+                log("No snabbswitch zones provided", level=INFO)
+                # Make sure a zones file exists if a path is set.
+                if not os.path.isfile(zones_file):
+                    with open(zones_file, 'w') as fd:
+                        fd.write('[]')
+
+        # Make sure neutron user can read file.
+        try:
+            user = pwd.getpwnam('neutron')
+            uid, gid = user.pw_uid, user.pw_gid
+            os.chown(zones_file, uid, gid)
+        except KeyError:
+            # may not be installed/configured yet
+            pass
+
+    def snabb_ctxt(self):
+        driver = neutron_plugin_attribute(self.plugin, 'driver',
+                                          self.network_manager)
+        snabb_config = neutron_plugin_attribute(self.plugin, 'config',
+                                                self.network_manager)
+        snabb_ctxt = {
+            'core_plugin': driver,
+            'neutron_plugin': 'snabb',
+            'neutron_security_groups': self.neutron_security_groups,
+            'local_ip': unit_private_ip(),
+            'config': snabb_config,
+        }
+
+        snabb_ctxt['zone_definition_file'] = self.SNABBSWITCH_ML2_ZONES_FILE
+        self._snabb_init_zones_file(self.SNABBSWITCH_ML2_ZONES_FILE)
+
+        return snabb_ctxt
+
     def calico_ctxt(self):
         driver = neutron_plugin_attribute(self.plugin, 'driver',
                                           self.network_manager)
@@ -988,6 +1062,10 @@
             ctxt.update(self.pg_ctxt())
         elif self.plugin == 'midonet':
             ctxt.update(self.midonet_ctxt())
+        elif self.plugin == 'snabb':
+            ctxt.update(self.snabb_ctxt())
+        else:
+            log("Unknown neutron plugin '%s'" % (self.plugin), level=INFO)
 
         alchemy_flags = config('neutron-alchemy-flags')
         if alchemy_flags:

=== modified file 'charmhelpers/contrib/openstack/neutron.py'
--- charmhelpers/contrib/openstack/neutron.py	2015-10-07 10:57:11 +0000
+++ charmhelpers/contrib/openstack/neutron.py	2015-10-23 09:05:27 +0000
@@ -161,6 +161,19 @@
                                 'neutron-plugin-cisco'],
             'server_services': ['neutron-server']
         },
+        'snabb': {
+            'config': '/etc/neutron/plugins/ml2/ml2_conf.ini',
+            'driver': 'neutron.plugins.ml2.plugin.Ml2Plugin',
+            'contexts': [
+                context.SharedDBContext(user=config('neutron-database-user'),
+                                        database=config('neutron-database'),
+                                        relation_prefix='neutron',
+                                        ssl_dir=NEUTRON_CONF_DIR)],
+            'services': [],
+            'packages': [],
+            'server_packages': ['neutron-server'],
+            'server_services': ['neutron-server']
+        },
         'Calico': {
             'config': '/etc/neutron/plugins/ml2/ml2_conf.ini',
             'driver': 'neutron.plugins.ml2.plugin.Ml2Plugin',

=== modified file 'charmhelpers/core/host.py'
--- charmhelpers/core/host.py	2015-10-15 05:34:04 +0000
+++ charmhelpers/core/host.py	2015-10-23 09:05:27 +0000
@@ -35,7 +35,10 @@
 
 import six
 
-from .hookenv import log
+from .hookenv import (
+    log,
+    ERROR
+)
 from .fstab import Fstab
 
 
@@ -109,12 +112,38 @@
     return started
 
 
-def service(action, service_name):
+def service(action, service_name, inst_args=None):
     """Control a system service"""
     cmd = ['service', service_name, action]
+    if inst_args:
+        cmd += inst_args
     return subprocess.call(cmd) == 0
 
 
+def get_service_args(conf, keys, allow_comments=True):
+    """Fetch service args from conf file (if exists)"""
+    args = []
+    if os.path.isfile(conf):
+        with open(conf, 'r') as fd:
+            for i, line in enumerate(fd.readlines()):
+                if allow_comments and line.startswith('#'):
+                    continue
+
+                cfg = line.split()
+                a = len(cfg)
+                b = len(keys)
+                if a > b:
+                    log("Invalid parameters found in config file - found=%s "
+                        "expected=%s" % (a, b), level=ERROR)
+                    return None
+
+                args.append(['%s=%s' % (keys[i], c) for i, c in enumerate(cfg)])
+
+        return args
+
+    return None
+
+
 def service_running(service):
     """Determine whether a system service is running"""
     try:

=== modified file 'tests/contrib/openstack/test_os_contexts.py'
--- tests/contrib/openstack/test_os_contexts.py	2015-10-07 10:57:11 +0000
+++ tests/contrib/openstack/test_os_contexts.py	2015-10-23 09:05:27 +0000
@@ -1,7 +1,13 @@
 import charmhelpers.contrib.openstack.context as context
+
+import bz2
 import yaml
 import json
 import unittest
+import tempfile
+import shutil
+import os
+import base64
 from copy import copy, deepcopy
 from mock import (
     patch,
@@ -10,6 +16,9 @@
     call
 )
 from tests.helpers import patch_open
+from charmhelpers.contrib.openstack.context import (
+    NeutronContext
+)
 
 import six
 
@@ -2145,6 +2154,130 @@
         config.return_value = 'good_flag=woot=='
         self.assertRaises(context.OSContextError, flags)
 
+    @patch('charmhelpers.contrib.openstack.context.config')
+    @patch('pwd.getpwnam')
+    @patch('os.chown')
+    def test_init_zones_file_no_file(self, mock_chown, mock_getpwnam,
+                                     mock_config):
+        with tempfile.NamedTemporaryFile() as tmpfile:
+            mock_config.return_value = None
+            NeutronContext()._snabb_init_zones_file(tmpfile.name)
+
+            with open(tmpfile.name) as fd:
+                data = fd.read()
+
+            self.assertEqual(data, '')
+            self.assertTrue(mock_chown.called)
+
+    @patch('charmhelpers.contrib.openstack.context.config')
+    @patch('pwd.getpwnam')
+    @patch('os.chown')
+    def test_init_zones_file_no_defs(self, mock_chown, mock_getpwnam,
+                                     mock_config):
+        with tempfile.NamedTemporaryFile() as tmpfile:
+
+            def _mock_config(name):
+                if name == 'snabbswitch-zones':
+                    return None
+
+            mock_config.side_effect = _mock_config
+            NeutronContext()._snabb_init_zones_file(tmpfile.name)
+
+            with open(tmpfile.name) as fd:
+                data = fd.read()
+
+            self.assertEqual(data, '')
+            self.assertTrue(mock_getpwnam.called)
+            self.assertTrue(mock_chown.called)
+
+    @patch('charmhelpers.contrib.openstack.context.config')
+    @patch('subprocess.check_output')
+    @patch('pwd.getpwnam')
+    @patch('os.chown')
+    def test_init_zones_file(self, mock_chown, mock_getpwnam,
+                             mock_check_output, mock_config):
+        out = "[{'host': 'HostA}]"
+        mock_check_output.return_value = out
+
+        zone_defs = base64.b64encode(out.encode('ascii'))
+        with tempfile.NamedTemporaryFile() as tmpfile:
+
+            def _mock_config(name):
+                if name == 'snabbswitch-zones':
+                    return zone_defs
+
+            mock_config.side_effect = _mock_config
+            NeutronContext()._snabb_init_zones_file(tmpfile.name)
+
+            with open(tmpfile.name) as fd:
+                data = fd.read()
+
+            self.assertTrue(mock_config.called)
+            self.assertEqual(data, out)
+            self.assertTrue(mock_getpwnam.called)
+            self.assertTrue(mock_chown.called)
+
+    @patch('charmhelpers.contrib.openstack.context.config')
+    @patch('subprocess.check_output')
+    @patch('pwd.getpwnam')
+    @patch('os.chown')
+    def test_init_zones_file_raw(self, mock_chown, mock_getpwnam,
+                                 mock_check_output, mock_config):
+        out = "[{'host': 'HostA}]"
+        mock_check_output.return_value = out
+        ctxt = NeutronContext()
+        ctxt.CONFFILES_DIR = tempfile.mkdtemp()
+        ctxt.SNABBSWITCH_ML2_ZONES_FILE = os.path.join(tempfile.mkdtemp(),
+                                                       'ml2_zones.txt')
+        try:
+            src = os.path.join(ctxt.CONFFILES_DIR, 'ml2_zones.txt')
+            dst = os.path.join(ctxt.SNABBSWITCH_ML2_ZONES_FILE)
+            with open(src, 'w') as fd:
+                fd.write(out)
+
+            ctxt._snabb_init_zones_file(ctxt.SNABBSWITCH_ML2_ZONES_FILE)
+
+            with open(dst) as fd:
+                data = fd.read()
+        finally:
+            shutil.rmtree(ctxt.CONFFILES_DIR)
+
+        self.assertFalse(mock_config.called)
+        self.assertEqual(data, out)
+        self.assertTrue(mock_getpwnam.called)
+        self.assertTrue(mock_chown.called)
+
+    @patch('charmhelpers.contrib.openstack.context.config')
+    @patch('subprocess.check_output')
+    @patch('pwd.getpwnam')
+    @patch('os.chown')
+    def test_init_zones_file_bz2(self, mock_chown, mock_getpwnam,
+                                 mock_check_output, mock_config):
+        out = "[{'host': 'HostA}]"
+        mock_check_output.return_value = out
+        ctxt = NeutronContext()
+        ctxt.CONFFILES_DIR = tempfile.mkdtemp()
+        ctxt.SNABBSWITCH_ML2_ZONES_FILE = os.path.join(tempfile.mkdtemp(),
+                                                       'ml2_zones.txt')
+        try:
+            src = os.path.join(ctxt.CONFFILES_DIR, 'ml2_zones.txt')
+            dst = os.path.join(ctxt.SNABBSWITCH_ML2_ZONES_FILE)
+            bz_file = bz2.BZ2File(src, 'w')
+            bz_file.write(out.encode('ascii'))
+            bz_file.close()
+
+            ctxt._snabb_init_zones_file(ctxt.SNABBSWITCH_ML2_ZONES_FILE)
+
+            with open(dst) as fd:
+                data = fd.read()
+        finally:
+            shutil.rmtree(ctxt.CONFFILES_DIR)
+
+        self.assertFalse(mock_config.called)
+        self.assertEqual(data, out)
+        self.assertTrue(mock_getpwnam.called)
+        self.assertTrue(mock_chown.called)
+
     @patch.object(context, 'config')
     def test_os_configflag_context_custom(self, config):
         flags = context.OSConfigFlagContext(