Merge lp:~gandelman-a/juju-deployer/multi_file_include into lp:juju-deployer

[Adam Gandelman]

Adds the ability to include multiple configs in a single include statement. Allows for better organization of deployer config snippets among different files. Example use-case:

include-config:
   - storage/backends.yaml
   - networking/backends.yaml

test_deployment:
   inherits: [storage_ceph, networking_nvp]

[lp:~gandelman-a/juju-deployer/multi_file_include]

77. By Adam Gandelman on 2013-10-11

Also pop 'include-configs' when loading.

[Kapil Thangavelu (hazmat)]

Looks good, surprised it wasn't already available.

review: Approve

=== modified file 'deployer/config.py'
--- deployer/config.py	2013-07-30 19:31:59 +0000
+++ deployer/config.py	2013-10-11 01:44:44 +0000
@@ -69,8 +69,9 @@
             d = self._yaml_load(fp)
             data = dict_merge(data, d)
         self.data = data
-        if 'include-config' in self.data:
-            self.data.pop('include-config')
+        for k in ['include-config', 'include-configs']:
+            if k in self.data:
+                self.data.pop(k)
         self.include_dirs = include_dirs
 
     def _inherits(self, d):
@@ -94,11 +95,19 @@
     def _includes(self, config_file):
         files = [config_file]
         d = self._yaml_load(config_file)
-        if 'include-config' in d:
-            inc_f = d['include-config']
-            if not isabs(inc_f):
-                inc_f = join(dirname(config_file), inc_f)
-            files.extend(self._includes(inc_f))
+
+        incs = d.get('include-configs') or d.get('include-config')
+        if isinstance(incs, basestring):
+            inc_fs = [incs]
+        else:
+            inc_fs = incs
+
+        if inc_fs:
+            for inc_f in inc_fs:
+                if not isabs(inc_f):
+                    inc_f = join(dirname(config_file), inc_f)
+                files.extend(self._includes(inc_f))
+
         return files
 
     def _resolve_included(self):

=== modified file 'deployer/tests/test_config.py'
--- deployer/tests/test_config.py	2013-07-30 20:43:31 +0000
+++ deployer/tests/test_config.py	2013-10-11 01:44:44 +0000
@@ -1,5 +1,7 @@
 import logging
 import os
+import tempfile
+import yaml
 
 from deployer.deployment import Deployment
 from deployer.config import ConfigStack
@@ -73,7 +75,28 @@
         ])
         self._test_multiple_inheritance(config)
 
-    def test_multi_inheritance_included_files(self):
+    def test_multi_inheritance_multi_included_files(self):
+        # openstack.cfg
+        #  includes -> ubuntu_base.cfg includes
+        #               includes -> openstack_base.cfg
+        test_conf = yaml.load(open(
+            os.path.join(self.test_data_dir, "openstack", "openstack.cfg")))
+        includes = [
+            os.path.join(self.test_data_dir, "openstack", "ubuntu_base.cfg"),
+            os.path.join(self.test_data_dir, "openstack", "openstack_base.cfg")
+        ]
+        for key in ['include-config', 'include-configs']:
+            test_conf[key] = includes
+            with tempfile.NamedTemporaryFile() as tmp_cfg:
+                tmp_cfg.write(yaml.dump(test_conf))
+                tmp_cfg.flush()
+                config = ConfigStack([tmp_cfg.name])
+                self._test_multiple_inheritance(config)
+            del test_conf[key]
+
+    def test_multi_inheritance_included_multi_configs(self):
+        # openstack.cfg
+        #  includes -> [ubuntu_base.cfg, openstack_base.cfg]
         config = ConfigStack([
             os.path.join(self.test_data_dir, "openstack", "openstack.cfg"),
         ])