Merge lp:~harlowja/cloud-init/cloud-init-enhanced-bootcmd into lp:~cloud-init-dev/cloud-init/trunk

[Joshua Harlow]

Some small enhancements to bootcmd module.

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:1248
https://server-team-jenkins.canonical.com/job/cloud-init-ci/40/
Executed test runs:
    None: https://server-team-jenkins.canonical.com/job/lp-vote-on-merge/14/console

Click here to trigger a rebuild:
https://server-team-jenkins.canonical.com/job/cloud-init-ci/40/rebuild

review: Approve (continuous-integration)

[Scott Moser (smoser)]

Hello,
Thank you for taking the time to contribute to cloud-init. Cloud-init has moved its revision control system to git. As a result, we are marking all bzr merge proposals as 'rejected'. If you would like to re-submit this proposal for review, please do so by following the current HACKING documentation at http://cloudinit.readthedocs.io/en/latest/topics/hacking.html .

I do really like this change, please do resubmit.

Unmerged revisions

1248. By Joshua Harlow on 2016-06-23

Also handle tuples correctly.

1247. By Joshua Harlow on 2016-06-23

Only add the shellify header if its really needed.

1246. By Joshua Harlow on 2016-06-23

Allow more env values for bootcmd module

Instead of just the basic iid it can be quite
useful to pass more information into the shell
command that is eventually ran (then the script
that is ran doesn't have to gather this same
info itself).

=== modified file 'cloudinit/config/cc_bootcmd.py'
--- cloudinit/config/cc_bootcmd.py	2016-05-12 17:56:26 +0000
+++ cloudinit/config/cc_bootcmd.py	2016-06-23 20:04:24 +0000
@@ -26,6 +26,25 @@
 frequency = PER_ALWAYS
 
 
+def create_env(cloud):
+    env = os.environ.copy()
+    iid = cloud.get_instance_id()
+    if iid:
+        env['INSTANCE_ID'] = str(iid)
+    launch_index = cloud.launch_index()
+    if launch_index is not None:
+        env['LAUNCH_INDEX'] = str(launch_index)
+    hostname = cloud.get_hostname()
+    if hostname:
+        env['HOSTNAME'] = str(hostname)
+    for k, v in [('AVAILABILITY_ZONE', cloud.datasource.availability_zone),
+                 ('REGION', cloud.datasource.region),
+                 ('LOCALE', cloud.get_locale())]:
+        if v:
+            env[k] = str(v)
+    return env
+
+
 def handle(name, cfg, cloud, log, _args):
 
     if "bootcmd" not in cfg:
@@ -43,12 +62,8 @@
             raise
 
         try:
-            env = os.environ.copy()
-            iid = cloud.get_instance_id()
-            if iid:
-                env['INSTANCE_ID'] = str(iid)
             cmd = ['/bin/sh', tmpf.name]
-            util.subp(cmd, env=env, capture=False)
+            util.subp(cmd, env=create_env(cloud), capture=False)
         except Exception:
             util.logexc(log, "Failed to run bootcmd module %s", name)
             raise

=== modified file 'cloudinit/util.py'
--- cloudinit/util.py	2016-06-16 03:32:22 +0000
+++ cloudinit/util.py	2016-06-23 20:04:24 +0000
@@ -1746,16 +1746,14 @@
 #  for each entry in the list
 #    if it is an array, shell protect it (with single ticks)
 #    if it is a string, do nothing
-def shellify(cmdlist, add_header=True):
+def shellify(cmdlist, add_header=True, header="#!/bin/sh\n"):
     content = ''
-    if add_header:
-        content += "#!/bin/sh\n"
     escaped = "%s%s%s%s" % ("'", '\\', "'", "'")
     cmds_made = 0
     for args in cmdlist:
         # If the item is a list, wrap all items in single tick.
         # If its not, then just write it directly.
-        if isinstance(args, list):
+        if isinstance(args, (list, tuple)):
             fixed = []
             for f in args:
                 fixed.append("'%s'" % (six.text_type(f).replace("'", escaped)))
@@ -1769,6 +1767,8 @@
                                 " which is not a list or string")
                                % (type_utils.obj_name(args)))
     LOG.debug("Shellified %s commands.", cmds_made)
+    if add_header and header and not content.startswith(header):
+        content = header + content
     return content