From faed1b2d0544a9f1941532d542ca13b4bc36cc5b Mon Sep 17 00:00:00 2001
From: Brian Coca <brian.coca+git@gmail.com>
Date: Tue, 16 Jun 2015 19:20:25 -0400
Subject: [PATCH] better error reporting when doc parsing fails

---
 lib/ansible/cli/doc.py | 63 ++++++++++++++++++++++--------------------
 1 file changed, 33 insertions(+), 30 deletions(-)

diff --git a/lib/ansible/cli/doc.py b/lib/ansible/cli/doc.py
index 797a59f0381..09020b41ffe 100644
--- a/lib/ansible/cli/doc.py
+++ b/lib/ansible/cli/doc.py
@@ -81,43 +81,46 @@ class DocCLI(CLI):
         text = ''
         for module in self.args:
 
-            filename = module_loader.find_plugin(module)
-            if filename is None:
-                self.display.warning("module %s not found in %s\n" % (module, DocCLI.print_paths(module_loader)))
-                continue
+            try:
+                filename = module_loader.find_plugin(module)
+                if filename is None:
+                    self.display.warning("module %s not found in %s\n" % (module, DocCLI.print_paths(module_loader)))
+                    continue
 
-            if any(filename.endswith(x) for x in self.BLACKLIST_EXTS):
-                continue
+                if any(filename.endswith(x) for x in self.BLACKLIST_EXTS):
+                    continue
 
-            try:
-                doc, plainexamples, returndocs = module_docs.get_docstring(filename)
-            except:
-                self.display.vvv(traceback.print_exc())
-                self.display.error("module %s has a documentation error formatting or is missing documentation\nTo see exact traceback use -vvv" % module)
-                continue
+                try:
+                    doc, plainexamples, returndocs = module_docs.get_docstring(filename)
+                except:
+                    self.display.vvv(traceback.print_exc())
+                    self.display.error("module %s has a documentation error formatting or is missing documentation\nTo see exact traceback use -vvv" % module)
+                    continue
 
-            if doc is not None:
+                if doc is not None:
 
-                all_keys = []
-                for (k,v) in doc['options'].iteritems():
-                    all_keys.append(k)
-                all_keys = sorted(all_keys)
-                doc['option_keys'] = all_keys
+                    all_keys = []
+                    for (k,v) in doc['options'].iteritems():
+                        all_keys.append(k)
+                    all_keys = sorted(all_keys)
+                    doc['option_keys'] = all_keys
 
-                doc['filename']         = filename
-                doc['docuri']           = doc['module'].replace('_', '-')
-                doc['now_date']         = datetime.date.today().strftime('%Y-%m-%d')
-                doc['plainexamples']    = plainexamples
-                doc['returndocs']       = returndocs
+                    doc['filename']         = filename
+                    doc['docuri']           = doc['module'].replace('_', '-')
+                    doc['now_date']         = datetime.date.today().strftime('%Y-%m-%d')
+                    doc['plainexamples']    = plainexamples
+                    doc['returndocs']       = returndocs
 
-                if self.options.show_snippet:
-                    text += DocCLI.get_snippet_text(doc)
+                    if self.options.show_snippet:
+                        text += DocCLI.get_snippet_text(doc)
+                    else:
+                        text += DocCLI.get_man_text(doc)
                 else:
-                    text += DocCLI.get_man_text(doc)
-            else:
-                # this typically means we couldn't even parse the docstring, not just that the YAML is busted,
-                # probably a quoting issue.
-                self.display.warning("module %s missing documentation (or could not parse documentation)\n" % module)
+                    # this typically means we couldn't even parse the docstring, not just that the YAML is busted,
+                    # probably a quoting issue.
+                    raise AnsibleError("Parsing produced an empty object.")
+            except Exception, e:
+                raise AnsibleError("module %s missing documentation (or could not parse documentation): %s\n" % (module, str(e)))
 
         CLI.pager(text)
         return 0