Adds error reporting to splunk ui as well as the log file

Signed-off-by: David Noble <[email protected]>

Author: David Noble

splunklib/results.py

@@ -246,16 +246,18 @@ def _parse_results(self, stream):
                         elem.clear()
 
                 elif elem.tag in ('text', 'v') and event == 'end':
-                    values.append(elem.text.encode('utf8'))
+                    text = elem.text if elem.text is not None else ""
+                    values.append(text.encode('utf8'))
                     elem.clear()
 
                 elif elem.tag == 'msg':
                     if event == 'start':
                         msg_type = elem.attrib['type']
                     elif event == 'end':
-                        yield Message(msg_type, elem.text.encode('utf8'))
+                        text = elem.text if elem.text is not None else ""
+                        yield Message(msg_type, text.encode('utf8'))
                         elem.clear()
-        except et.ParseError as pe:
+        except SyntaxError as pe:
             # This is here to handle the same incorrect return from
             # splunk that is described in __init__.
             if 'no element found' in pe.msg:

splunklib/searchcommands/generating_command.py

@@ -12,6 +12,8 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+from __future__ import absolute_import
+
 from . search_command import SearchCommand
 
 
@@ -79,9 +81,7 @@ def _execute(self, operation, reader, writer):
                 writer.writerow(record)
         except Exception as e:
             from traceback import format_exc
-            from sys import exit
-            self.logger.error(format_exc())
-            exit(1)
+            self._exit(format_exc(), e, 1)
 
     def _prepare(self, argv, input_file):
         ConfigurationSettings = type(self).ConfigurationSettings

splunklib/searchcommands/reporting_command.py

@@ -77,9 +77,7 @@ def _execute(self, operation, reader, writer):
                 writer.writerow(record)
         except Exception as e:
             from traceback import format_exc
-            from sys import exit
-            self.logger.error(format_exc())
-            exit(1)
+            self._exit(format_exc(), e, 1)
 
     def _prepare(self, argv, input_file):
         if len(argv) >= 3 and argv[2] == '__map__':

splunklib/searchcommands/search_command.py

@@ -26,7 +26,7 @@
 from inspect import getmembers
 from logging import _levelNames, getLevelName
 from os import path
-from sys import argv, stdin, stdout
+from sys import argv, exit, stdin, stdout
 from urlparse import urlsplit
 from xml.etree import ElementTree
 
@@ -59,6 +59,7 @@ def __init__(self):
         self._configuration = None
         self._fieldnames = None
         self._option_view = None
+        self._output_file = None
         self._search_results_info = None
         self._service = None
 
@@ -281,6 +282,7 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
 
         """
         self.logger.debug('%s arguments: %s' % (type(self).__name__, args))
+        self._outputfile = output_file
         self._configuration = None
 
         if len(args) >= 2 and args[1] == '__GETINFO__':
@@ -290,10 +292,8 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
             try:
                 self.parser.parse(args, self)
             except (SyntaxError, ValueError) as e:
-                writer = csv.DictWriter(output_file, self, fieldnames=['ERROR'])
-                writer.writerow({'ERROR': e})
-                self.logger.error(e)
-                return
+                from traceback import format_exc
+                self._exit(format_exc(), e, 1)
 
             self._configuration = ConfigurationSettings(self)
 
@@ -310,11 +310,8 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
             try:
                 self.parser.parse(args, self)
             except (SyntaxError, ValueError) as e:
-                from sys import exit
-                self.messages.append("error_message", e)
-                self.messages.write(output_file)
-                self.logger.error(e)
-                exit(1)
+                from traceback import format_exc
+                self._exit(format_exc(), e, 1)
 
             self._configuration = ConfigurationSettings(self)
 
@@ -339,9 +336,7 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
                 'supports_getinfo = true | '
                 'supports_rawargs = true | '
                 'outputheader = true'.format(type(self).name, file_name))
-            self.messages.append('error_message', message)
-            self.messages.write(output_file)
-            self.logger.error(message)
+            self._exit(message, message, 1)
 
     @staticmethod
     def records(reader):
@@ -355,6 +350,12 @@ def _prepare(self, argv, input_file):
     def _execute(self, operation, reader, writer):
         raise NotImplementedError('SearchCommand._configure(self, argv)')
 
+    def _exit(self, log, error, status_code):
+        writer = csv.DictWriter(self.output_file, self, fieldnames=['ERROR'])
+        writer.writerow({'ERROR': error})
+        self.logger.error(log)
+        exit(status_code)
+
     #endregion
 
     #region Types

splunklib/searchcommands/streaming_command.py

@@ -12,6 +12,8 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+from __future__ import absolute_import
+
 from . search_command import SearchCommand
 from . import csv
 
@@ -74,9 +76,7 @@ def _execute(self, operation, reader, writer):
                 writer.writerow(record)
         except Exception as e:
             from traceback import format_exc
-            from sys import exit
-            self.logger.error(format_exc())
-            exit(1)
+            self._exit(format_exc(), e, 1)
 
     def _prepare(self, argv, input_file):
         ConfigurationSettings = type(self).ConfigurationSettings