Merge lp:~shraddha-pandhe/cloud-init/debug-module into lp:~cloud-init-dev/cloud-init/trunk

[Shraddha Pandhe]

[Scott Moser (smoser)]

Neat!

I have a few nitpicks / suggestions:
 * namespace the 'verbose' in config to appear under a 'debug'. Ie:
    #cloud-config
    debug:
     verbose: True
 * Allow me to set the target filename to write to:
    #cloud-config
    debug:
     output: /tmp/debug.out
 * possibly we could combine the 2 and just drop 'verbose'. Do nothing if 'output' isn't set, rather than if verbose is set to true.

 * lastly, allow argument to set 'output'.
   Ie, i'd like to be able to do:
     cloud-init single --frequency=always --name=debug /tmp/debug.out
     cat debug.out

make sense?
Thanks!

[lp:~shraddha-pandhe/cloud-init/debug-module]

898. By Shraddha Pandhe on 2013-12-11

bug: 1258619 added namespace for config options, output file, commandline argument for output file

[Joshua Harlow (harlowja)]

One change, _format_yaml seems similar to util.yaml_dumps, seems like just can use that instead.

[lp:~shraddha-pandhe/cloud-init/debug-module]

899. By Shraddha Pandhe on 2013-12-11

essage

900. By Shraddha Pandhe on 2013-12-11

Removed method _format_yaml

901. By Shraddha Pandhe on 2013-12-11

Removed yaml import

[Joshua Harlow (harlowja)]

Seems ok with me. Thanks for this, is useful as a simple way of debugging what cloud-init is doing (or the data it contains) when that is needed (and you don't have access to the log file).

=== added file 'cloudinit/config/cc_debug.py'
--- cloudinit/config/cc_debug.py	1970-01-01 00:00:00 +0000
+++ cloudinit/config/cc_debug.py	2013-12-11 23:56:25 +0000
@@ -0,0 +1,76 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2013 Yahoo! Inc.
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3, as
+#    published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    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
+from cloudinit import util
+from cloudinit import type_utils
+import copy
+
+
+def _make_header(text):
+    header = StringIO()
+    header.write("-" * 80)
+    header.write("\n")
+    header.write(text.center(80, ' '))
+    header.write("\n")
+    header.write("-" * 80)
+    header.write("\n")
+    return header.getvalue()
+
+
+def handle(name, cfg, cloud, log, args):
+    verbose = util.get_cfg_by_path(cfg, ('debug','verbose'), default=True)
+    if not verbose:
+        log.debug(("Skipping module named %s,"
+                   " verbose printing disabled"), name)
+        return
+    out_file = None
+    if args:
+        out_file = args[0]
+    else:
+        out_file = util.get_cfg_by_path(cfg, ('debug','output'))
+    # Clean out some keys that we just don't care about showing...
+    dump_cfg = copy.deepcopy(cfg)
+    for k in ['log_cfgs']:
+        dump_cfg.pop(k, None)
+    all_keys = list(dump_cfg.keys())
+    for k in all_keys:
+        if k.startswith("_"):
+            dump_cfg.pop(k, None)
+    # Now dump it...
+    to_print = StringIO()
+    to_print.write(_make_header("Config"))
+    to_print.write(util.yaml_dumps(dump_cfg))
+    to_print.write("\n")
+    to_print.write(_make_header("MetaData"))
+    to_print.write(util.yaml_dumps(cloud.datasource.metadata))
+    to_print.write("\n")
+    to_print.write(_make_header("Misc"))
+    to_print.write("Datasource: %s\n" % (type_utils.obj_name(cloud.datasource)))
+    to_print.write("Distro: %s\n" % (type_utils.obj_name(cloud.distro)))
+    to_print.write("Hostname: %s\n" % (cloud.get_hostname(True)))
+    to_print.write("Instance ID: %s\n" % (cloud.get_instance_id()))
+    to_print.write("Locale: %s\n" % (cloud.get_locale()))
+    to_print.write("Launch IDX: %s\n" % (cloud.launch_index))
+    contents = to_print.getvalue()
+    content_to_file = []
+    for line in contents.splitlines():
+        line = "ci-info: %s\n" % (line)
+        content_to_file.append(line)
+    if out_file:
+        util.write_file(out_file, "".join(content_to_file), 0644, "w")
+    else:
+        util.multi_log("".join(content_to_file), console=True, stderr=False)