Complete initial cleanup for refactoring/rework.

Some of the cleanups were the following

1. Using standard (logged) utility functions for sub process work, writing, reading files, and other file system/operating system options
2. Having distrobutions impelement there own subclasses to handle system specifics (if applicable)
3. Having a cloud wrapper that provides just the functionality we want to expose (cloud.py)
4. Using a path class instead of globals for all cloud init paths (it is configured via config)
5. Removal of as much shared global state as possible (there should be none, minus a set of constants)
6. Other various cleanups that remove transforms/handlers/modules from reading/writing/chmoding there own files. 
 a. They should be using util functions to take advantage of the logging that is now enabled in those util functions (very useful for debugging)
7. Urls being read and checked from a single module that serves this and only this purpose (+1 for code organization)
8. Updates to log whenever a transform decides not to run
9. Ensure whenever a exception is thrown (and possibly captured) that the util.logexc function is called 
 a. For debugging, tracing this is important to not just drop them on the floor.
10. Code shuffling into utils.py where it makes sense (and where it could serve a benefit for other code now or in the future)

1 files changed, 44 insertions, 50 deletions

diff --git a/cloudinit/transforms/cc_puppet.py b/cloudinit/transforms/cc_puppet.py
index 6fc475f6..0a21a929 100644
--- a/cloudinit/transforms/cc_puppet.py
+++ b/cloudinit/transforms/cc_puppet.py
@@ -18,91 +18,85 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from StringIO import StringIO
+
 import os
-import os.path
 import pwd
 import socket
-import subprocess
-import StringIO
-import ConfigParser
-import cloudinit.CloudConfig as cc
-import cloudinit.util as util
+
+from cloudinit import util
+from cloudinit import cfg
 
 
-def handle(_name, cfg, cloud, log, _args):
+def handle(name, cfg, cloud, log, _args):
     # If there isn't a puppet key in the configuration don't do anything
     if 'puppet' not in cfg:
+        log.debug(("Skipping module named %s,"
+                   " no 'puppet' configuration found"), name)
         return
+
     puppet_cfg = cfg['puppet']
+
     # Start by installing the puppet package ...
-    cc.install_packages(("puppet",))
+    cloud.distro.install_packages(("puppet",))
 
     # ... and then update the puppet configuration
     if 'conf' in puppet_cfg:
         # Add all sections from the conf object to puppet.conf
-        puppet_conf_fh = open('/etc/puppet/puppet.conf', 'r')
+        contents = util.load_file('/etc/puppet/puppet.conf')
         # Create object for reading puppet.conf values
-        puppet_config = ConfigParser.ConfigParser()
+        puppet_config = cfg.DefaultingConfigParser()
         # Read puppet.conf values from original file in order to be able to
-        # mix the rest up
-        puppet_config.readfp(StringIO.StringIO(''.join(i.lstrip() for i in
-                                               puppet_conf_fh.readlines())))
-        # Close original file, no longer needed
-        puppet_conf_fh.close()
-        for cfg_name, cfg in puppet_cfg['conf'].iteritems():
+        # mix the rest up. First clean them up (TODO is this really needed??)
+        cleaned_contents = '\n'.join([i.lstrip() for i in contents.splitlines()])
+        puppet_config.readfp(StringIO(cleaned_contents),
+                             filename='/etc/puppet/puppet.conf')
+        for (cfg_name, cfg) in puppet_cfg['conf'].iteritems():
             # ca_cert configuration is a special case
             # Dump the puppetmaster ca certificate in the correct place
             if cfg_name == 'ca_cert':
                 # Puppet ssl sub-directory isn't created yet
                 # Create it with the proper permissions and ownership
-                os.makedirs('/var/lib/puppet/ssl')
-                os.chmod('/var/lib/puppet/ssl', 0771)
-                os.chown('/var/lib/puppet/ssl',
-                         pwd.getpwnam('puppet').pw_uid, 0)
-                os.makedirs('/var/lib/puppet/ssl/certs/')
-                os.chown('/var/lib/puppet/ssl/certs/',
-                         pwd.getpwnam('puppet').pw_uid, 0)
-                ca_fh = open('/var/lib/puppet/ssl/certs/ca.pem', 'w')
-                ca_fh.write(cfg)
-                ca_fh.close()
-                os.chown('/var/lib/puppet/ssl/certs/ca.pem',
-                         pwd.getpwnam('puppet').pw_uid, 0)
-                util.restorecon_if_possible('/var/lib/puppet', recursive=True)
+                util.ensure_dir('/var/lib/puppet/ssl', 0771)
+                util.chownbyid('/var/lib/puppet/ssl',
+                               pwd.getpwnam('puppet').pw_uid, 0)
+                util.ensure_dir('/var/lib/puppet/ssl/certs/')
+                util.chownbyid('/var/lib/puppet/ssl/certs/',
+                               pwd.getpwnam('puppet').pw_uid, 0)
+                util.write_file('/var/lib/puppet/ssl/certs/ca.pem', cfg)
+                util.chownbyid('/var/lib/puppet/ssl/certs/ca.pem',
+                               pwd.getpwnam('puppet').pw_uid, 0)
             else:
-                #puppet_conf_fh.write("\n[%s]\n" % (cfg_name))
-                # If puppet.conf already has this section we don't want to
-                # write it again
-                if puppet_config.has_section(cfg_name) == False:
-                    puppet_config.add_section(cfg_name)
                 # Iterate throug the config items, we'll use ConfigParser.set
                 # to overwrite or create new items as needed
-                for o, v in cfg.iteritems():
+                for (o, v) in cfg.iteritems():
                     if o == 'certname':
                         # Expand %f as the fqdn
+                        # TODO should this use the cloud fqdn??
                         v = v.replace("%f", socket.getfqdn())
                         # Expand %i as the instance id
-                        v = v.replace("%i",
-                              cloud.datasource.get_instance_id())
-                        # certname needs to be downcase
+                        v = v.replace("%i", cloud.get_instance_id())
+                        # certname needs to be downcased
                         v = v.lower()
                     puppet_config.set(cfg_name, o, v)
-                    #puppet_conf_fh.write("%s=%s\n" % (o, v))
             # We got all our config as wanted we'll rename
             # the previous puppet.conf and create our new one
-            os.rename('/etc/puppet/puppet.conf', '/etc/puppet/puppet.conf.old')
-            with open('/etc/puppet/puppet.conf', 'wb') as configfile:
-                puppet_config.write(configfile)
-            util.restorecon_if_possible('/etc/puppet/puppet.conf')
+            util.rename('/etc/puppet/puppet.conf', '/etc/puppet/puppet.conf.old')
+            contents = puppet_config.stringify()
+            util.write_file('/etc/puppet/puppet.conf', contents)
+
     # Set puppet to automatically start
     if os.path.exists('/etc/default/puppet'):
-        subprocess.check_call(['sed', '-i',
-                               '-e', 's/^START=.*/START=yes/',
-                               '/etc/default/puppet'])
+        util.subp(['sed', '-i',
+                  '-e', 's/^START=.*/START=yes/',
+                  '/etc/default/puppet'], capture=False)
     elif os.path.exists('/bin/systemctl'):
-        subprocess.check_call(['/bin/systemctl', 'enable', 'puppet.service'])
+        util.subp(['/bin/systemctl', 'enable', 'puppet.service'], capture=False)
     elif os.path.exists('/sbin/chkconfig'):
-        subprocess.check_call(['/sbin/chkconfig', 'puppet', 'on'])
+        util.subp(['/sbin/chkconfig', 'puppet', 'on'], capture=False)
     else:
-        log.warn("Do not know how to enable puppet service on this system")
+        log.warn(("Sorry we do not know how to enable"
+                  " puppet services on this system"))
+
     # Start puppetd
-    subprocess.check_call(['service', 'puppet', 'start'])
+    util.subp(['service', 'puppet', 'start'], capture=False)