DataSourceNoCloud: allow setting user-data and meta-data in config

This allows a single file to declare and activate this data source.

This could come from:
 * cloud-config-url on kernel cmdline
 * /etc/cloud/cloud.cfg.d
 * debian preseed of 'cloud-init/local-cloud-config'

Also here is
 * some tests
 * a small fix to parse_cmdline_data found when writing those tests.

LP: #1115833

6 files changed, 221 insertions, 38 deletions

diff --git a/ChangeLog b/ChangeLog
index 639d5560..7d1503bf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -38,6 +38,8 @@
  - fix documentation for write_files to correctly list 'permissions'
    rather than 'perms' (LP: #1111205)
  - cloud-init-container.conf: ensure /run/network before running ifquery
+ - DataSourceNoCloud: allow user-data and meta-data to be specified
+   in config (LP: #1115833).
 0.7.1:
  - sysvinit: fix missing dependency in cloud-init job for RHEL 5.6 
  - config-drive: map hostname to local-hostname (LP: #1061964)
diff --git a/cloudinit/sources/DataSourceNoCloud.py b/cloudinit/sources/DataSourceNoCloud.py
index bed500a2..097bbc52 100644
--- a/cloudinit/sources/DataSourceNoCloud.py
+++ b/cloudinit/sources/DataSourceNoCloud.py
@@ -77,37 +77,47 @@ class DataSourceNoCloud(sources.DataSource):
             found.append("ds_config")
             md["seedfrom"] = self.ds_cfg['seedfrom']
 
-        fslist = util.find_devs_with("TYPE=vfat")
-        fslist.extend(util.find_devs_with("TYPE=iso9660"))
-
-        label_list = util.find_devs_with("LABEL=cidata")
-        devlist = list(set(fslist) & set(label_list))
-        devlist.sort(reverse=True)
-
-        for dev in devlist:
-            try:
-                LOG.debug("Attempting to use data from %s", dev)
-
-                (newmd, newud) = util.mount_cb(dev, util.read_seeded)
-                md = util.mergedict(newmd, md)
-                ud = newud
-
-                # For seed from a device, the default mode is 'net'.
-                # that is more likely to be what is desired.
-                # If they want dsmode of local, then they must
-                # specify that.
-                if 'dsmode' not in md:
-                    md['dsmode'] = "net"
-
-                LOG.debug("Using data from %s", dev)
-                found.append(dev)
-                break
-            except OSError as e:
-                if e.errno != errno.ENOENT:
-                    raise
-            except util.MountFailedError:
-                util.logexc(LOG, ("Failed to mount %s"
-                                  " when looking for data"), dev)
+        # if ds_cfg has 'user-data' and 'meta-data'
+        if 'user-data' in self.ds_cfg and 'meta-data' in self.ds_cfg:
+            if self.ds_cfg['user-data']:
+                ud = self.ds_cfg['user-data']
+            if self.ds_cfg['meta-data'] is not False:
+                md = util.mergedict(md, self.ds_cfg['meta-data'])
+            if 'ds_config' not in found:
+                found.append("ds_config")
+
+        if self.ds_cfg.get('fs_label', "cidata"):
+            fslist = util.find_devs_with("TYPE=vfat")
+            fslist.extend(util.find_devs_with("TYPE=iso9660"))
+
+            label = self.ds_cfg.get('fs_label')
+            label_list = util.find_devs_with("LABEL=%s" % label)
+            devlist = list(set(fslist) & set(label_list))
+            devlist.sort(reverse=True)
+
+            for dev in devlist:
+                try:
+                    LOG.debug("Attempting to use data from %s", dev)
+
+                    (newmd, newud) = util.mount_cb(dev, util.read_seeded)
+                    md = util.mergedict(newmd, md)
+                    ud = newud
+
+                    # For seed from a device, the default mode is 'net'.
+                    # that is more likely to be what is desired.  If they want
+                    # dsmode of local, then they must specify that.
+                    if 'dsmode' not in md:
+                        md['dsmode'] = "net"
+
+                    LOG.debug("Using data from %s", dev)
+                    found.append(dev)
+                    break
+                except OSError as e:
+                    if e.errno != errno.ENOENT:
+                        raise
+                except util.MountFailedError:
+                    util.logexc(LOG, ("Failed to mount %s"
+                                      " when looking for data"), dev)
 
         # There was no indication on kernel cmdline or data
         # in the seeddir suggesting this handler should be used.
@@ -195,6 +205,8 @@ def parse_cmdline_data(ds_id, fill, cmdline=None):
     # short2long mapping to save cmdline typing
     s2l = {"h": "local-hostname", "i": "instance-id", "s": "seedfrom"}
     for item in kvpairs:
+        if item == "":
+            continue
         try:
             (k, v) = item.split("=", 1)
         except:
diff --git a/doc/examples/cloud-config-datasources.txt b/doc/examples/cloud-config-datasources.txt
index d10dde05..fc8c22d4 100644
--- a/doc/examples/cloud-config-datasources.txt
+++ b/doc/examples/cloud-config-datasources.txt
@@ -31,3 +31,14 @@ datasource:
     #    <url>/user-data and <url>/meta-data
     # seedfrom: http://my.example.com/i-abcde
     seedfrom: None
+
+    # fs_label: the label on filesystems to be searched for NoCloud source
+    fs_label: cidata
+
+    # these are optional, but allow you to basically provide a datasource
+    # right here
+    user-data: |
+       # This is the user-data verbatum
+    meta-data:
+       instance-id: i-87018aed
+       local-hostname: myhost.internal
diff --git a/tests/unittests/helpers.py b/tests/unittests/helpers.py
index 4258a29d..91a50e18 100644
--- a/tests/unittests/helpers.py
+++ b/tests/unittests/helpers.py
@@ -182,3 +182,10 @@ class FilesystemMockingTestCase(ResourceUsingTestCase):
                 trap_func = retarget_many_wrapper(new_root, 1, func)
                 setattr(mod, f, trap_func)
                 self.patched_funcs.append((mod, f, func))
+
+def populate_dir(path, files):
+    os.makedirs(path)
+    for (name, content) in files.iteritems():
+        with open(os.path.join(path, name), "w") as fp:
+            fp.write(content)
+            fp.close()
diff --git a/tests/unittests/test_datasource/test_maas.py b/tests/unittests/test_datasource/test_maas.py
index 85e6add0..b56fea82 100644
--- a/tests/unittests/test_datasource/test_maas.py
+++ b/tests/unittests/test_datasource/test_maas.py
@@ -3,6 +3,7 @@ import os
 
 from cloudinit.sources import DataSourceMAAS
 from cloudinit import url_helper
+from tests.unittests.helpers import populate_dir
 
 from mocker import MockerTestCase
 
@@ -137,11 +138,4 @@ class TestMAASDataSource(MockerTestCase):
         pass
 
 
-def populate_dir(seed_dir, files):
-    os.mkdir(seed_dir)
-    for (name, content) in files.iteritems():
-        with open(os.path.join(seed_dir, name), "w") as fp:
-            fp.write(content)
-            fp.close()
-
 # vi: ts=4 expandtab
diff --git a/tests/unittests/test_datasource/test_nocloud.py b/tests/unittests/test_datasource/test_nocloud.py
new file mode 100644
index 00000000..28e0a472
--- /dev/null
+++ b/tests/unittests/test_datasource/test_nocloud.py
@@ -0,0 +1,157 @@
+from cloudinit import helpers
+from tests.unittests.helpers import populate_dir
+from cloudinit.sources import DataSourceNoCloud
+from cloudinit import util
+
+from mocker import MockerTestCase
+import os
+import yaml
+
+
+class TestNoCloudDataSource(MockerTestCase):
+
+    def setUp(self):
+        self.tmp = self.makeDir()
+        self.paths = helpers.Paths({'cloud_dir': self.tmp})
+
+        self.cmdline = "root=TESTCMDLINE"
+
+        self.unapply = []
+        self.apply_patches([(util, 'get_cmdline', self._getcmdline)])
+        super(TestNoCloudDataSource, self).setUp()
+
+    def tearDown(self):
+        apply_patches([i for i in reversed(self.unapply)])
+        super(TestNoCloudDataSource, self).setUp()
+
+    def apply_patches(self, patches):
+        ret = apply_patches(patches)
+        self.unapply += ret
+
+    def _getcmdline(self):
+        return self.cmdline
+
+    def test_nocloud_seed_dir(self):
+        md = {'instance-id': 'IID', 'dsmode': 'local'}
+        ud = "USER_DATA_HERE"
+        populate_dir(os.path.join(self.paths.seed_dir, "nocloud"),
+                     {'user-data': ud, 'meta-data': yaml.safe_dump(md)})
+
+        sys_cfg = {
+            'datasource': {'NoCloud': {'fs_label': None}}
+        }
+
+        ds = DataSourceNoCloud.DataSourceNoCloud
+
+        dsrc = ds(sys_cfg=sys_cfg, distro=None, paths=self.paths)
+        ret = dsrc.get_data()
+        self.assertEqual(dsrc.userdata_raw, ud)
+        self.assertEqual(dsrc.metadata, md)
+        self.assertTrue(ret)
+
+    def test_fs_label(self):
+        #find_devs_with should not be called ff fs_label is None
+        ds = DataSourceNoCloud.DataSourceNoCloud
+
+        class PsuedoException(Exception):
+            pass
+
+        def my_find_devs_with(*args, **kwargs):
+            _f = (args, kwargs)
+            raise PsuedoException
+
+        self.apply_patches([(util, 'find_devs_with', my_find_devs_with)])
+
+        # by default, NoCloud should search for filesystems by label
+        sys_cfg = {'datasource': {'NoCloud': {}}}
+        dsrc = ds(sys_cfg=sys_cfg, distro=None, paths=self.paths)
+        self.assertRaises(PsuedoException, dsrc.get_data)
+
+        # but disabling searching should just end up with None found
+        sys_cfg = {'datasource': {'NoCloud': {'fs_label': None}}}
+        dsrc = ds(sys_cfg=sys_cfg, distro=None, paths=self.paths)
+        ret = dsrc.get_data()
+        self.assertFalse(ret)
+
+    def test_no_datasource_expected(self):
+        #no source should be found if no cmdline, config, and fs_label=None
+        sys_cfg = {'datasource': {'NoCloud': {'fs_label': None}}}
+
+        ds = DataSourceNoCloud.DataSourceNoCloud
+        dsrc = ds(sys_cfg=sys_cfg, distro=None, paths=self.paths)
+        self.assertFalse(dsrc.get_data())
+
+    def test_seed_in_config(self):
+        ds = DataSourceNoCloud.DataSourceNoCloud
+
+        data = {
+            'fs_label': None,
+            'meta-data': {'instance-id': 'IID'},
+            'user-data': "USER_DATA_RAW",
+        }
+
+        sys_cfg = {'datasource': {'NoCloud': data}}
+        dsrc = ds(sys_cfg=sys_cfg, distro=None, paths=self.paths)
+        ret = dsrc.get_data()
+        self.assertEqual(dsrc.userdata_raw, "USER_DATA_RAW")
+        self.assertEqual(dsrc.metadata.get('instance-id'), 'IID')
+        self.assertTrue(ret)
+
+
+class TestParseCommandLineData(MockerTestCase):
+
+    def test_parse_cmdline_data_valid(self):
+        ds_id = "ds=nocloud"
+        pairs = (
+            ("root=/dev/sda1 %(ds_id)s", {}),
+            ("%(ds_id)s; root=/dev/foo", {}),
+            ("%(ds_id)s", {}),
+            ("%(ds_id)s;", {}),
+            ("%(ds_id)s;s=SEED", {'seedfrom': 'SEED'}),
+            ("%(ds_id)s;seedfrom=SEED;local-hostname=xhost",
+             {'seedfrom': 'SEED', 'local-hostname': 'xhost'}),
+            ("%(ds_id)s;h=xhost",
+             {'local-hostname': 'xhost'}),
+            ("%(ds_id)s;h=xhost;i=IID",
+             {'local-hostname': 'xhost', 'instance-id': 'IID'}),
+        )
+
+        for (fmt, expected) in pairs:
+            fill = {}
+            cmdline = fmt % {'ds_id': ds_id}
+            ret = DataSourceNoCloud.parse_cmdline_data(ds_id=ds_id, fill=fill,
+                                                       cmdline=cmdline)
+            self.assertEqual(expected, fill)
+            self.assertTrue(ret)
+
+    def test_parse_cmdline_data_none(self):
+        ds_id = "ds=foo"
+        cmdlines = (
+            "root=/dev/sda1 ro",
+            "console=/dev/ttyS0 root=/dev/foo",
+            "",
+            "ds=foocloud",
+            "ds=foo-net",
+            "ds=nocloud;s=SEED",
+        )
+
+        for cmdline in cmdlines:
+            fill = {}
+            ret = DataSourceNoCloud.parse_cmdline_data(ds_id=ds_id, fill=fill,
+                                                       cmdline=cmdline)
+            self.assertEqual(fill, {})
+            self.assertFalse(ret)
+
+
+def apply_patches(patches):
+    ret = []
+    for (ref, name, replace) in patches:
+        if replace is None:
+            continue
+        orig = getattr(ref, name)
+        setattr(ref, name, replace)
+        ret.append((ref, name, orig))
+    return ret
+
+
+# vi: ts=4 expandtab