Merge branch 'feature/dnoble-bug_fixes' into develop

Author: Shakeel Mohamed

examples/searchcommands_app/bin/simulate.py

@@ -86,7 +86,7 @@ class SimulateCommand(GeneratingCommand):
 
     def generate(self):
         """ Yields one random record at a time for the duration of `duration` """
-        self.logger.debug('SimulateCommand: %s' % self)  # log command line
+        self.logger.debug('SimulateCommand: %s', self)  # log command line
         if not self.records:
             if self.seed is not None:
                 random.seed(self.seed)

splunklib/searchcommands/decorators.py

@@ -222,7 +222,7 @@ def __repr__(self):
             return str(self)
 
         def __str__(self):
-            value = self.validator.format(self.value) if self.validator is not None else str(self.value)
+            value = str(self.value) if self.validator is None else self.validator.format(self.value)
             encoder = Option.Encoder(self)
             text = '='.join([self.name, encoder.encode(value)])
             return text

splunklib/searchcommands/logging.py

@@ -19,8 +19,10 @@
 import os
 import sys
 
+def get_app_directory(probing_path):
+    return os.path.dirname(os.path.abspath(os.path.dirname(probing_path)))
 
-def configure(name, path=None):
+def configure(name, probing_path=None, app_root=None):
     """ Configure logging and return a logger and the location of its logging
     configuration file.
 
@@ -57,63 +59,66 @@ def configure(name, path=None):
     return.
 
     You may short circuit the search for a logging configuration file by
-    providing an alternative file location in `path`. Logging configuration
+    providing an alternative file location in `probing_path`. Logging configuration
     files must be in `ConfigParser format`_.
 
     #Arguments:
 
     :param name: Logger name
     :type name: str
-    :param path: Location of an alternative logging configuration file or `None`
-    :type path: str or NoneType
+    :param probing_path: Location of an alternative logging configuration file or `None`
+    :type probing_path: str or NoneType
     :returns: A logger and the location of its logging configuration file
+    :param app_root: The root of the application directory, used primarily by tests.
+    :type app_root: str or NoneType
 
     .. _ConfigParser format: http://goo.gl/K6edZ8
 
     """
-    app_directory = os.path.dirname(os.path.dirname(os.path.realpath(sys.argv[0])))
 
-    if path is None:
-        probing_path = [
+    app_directory = get_app_directory(sys.argv[0]) if app_root is None else app_root
+
+    if probing_path is None:
+        probing_paths = [
             'local/%s.logging.conf' % name,
             'default/%s.logging.conf' % name,
             'local/logging.conf',
             'default/logging.conf']
-        for relative_path in probing_path:
+        for relative_path in probing_paths:
             configuration_file = os.path.join(app_directory, relative_path)
             if os.path.exists(configuration_file):
-                path = configuration_file
+                probing_path = configuration_file
                 break
-    elif not os.path.isabs(path):
+    elif not os.path.isabs(probing_path):
         found = False
         for conf in 'local', 'default':
-            configuration_file = os.path.join(app_directory, conf, path)
+            configuration_file = os.path.join(app_directory, conf, probing_path)
             if os.path.exists(configuration_file):
-                path = configuration_file
+                probing_path = configuration_file
                 found = True
                 break
         if not found:
             raise ValueError(
                 'Logging configuration file "%s" not found in local or default '
-                'directory' % path)
-    elif not os.path.exists(path):
+                'directory' % probing_path)
+    elif not os.path.exists(probing_path):
         raise ValueError('Logging configuration file "%s" not found')
 
-    if path is not None:
+    if probing_path is not None:
         working_directory = os.getcwd()
         os.chdir(app_directory)
         try:
             splunk_home = os.path.normpath(os.path.join(working_directory, os.environ['SPLUNK_HOME']))
         except KeyError:
             splunk_home = working_directory  # reasonable in debug scenarios
         try:
-            path = os.path.abspath(path)
-            fileConfig(path, {'SPLUNK_HOME': splunk_home})
+            probing_path = os.path.abspath(probing_path)
+            fileConfig(probing_path, {'SPLUNK_HOME': splunk_home})
         finally:
             os.chdir(working_directory)
 
     if len(root.handlers) == 0:
         root.addHandler(StreamHandler())
 
     logger = getLogger(name)
-    return logger, path
+    return logger, probing_path

splunklib/searchcommands/search_command.py

@@ -43,11 +43,15 @@ class SearchCommand(object):
 
     """
 
-    def __init__(self):
+    def __init__(self, app_root=None):
+        """
+        :param app_root: The root of the application directory, used primarily by tests.
+        :type app_root: str or NoneType
+        """
 
         # Variables that may be used, but not altered by derived classes
 
-        self.logger, self._logging_configuration = logging.configure(type(self).__name__)
+        self.logger, self._logging_configuration = logging.configure(type(self).__name__, app_root=app_root)
         self.input_header = InputHeader()
         self.messages = MessagesHeader()
 
@@ -61,6 +65,7 @@ def __init__(self):
 
         # Variables backing option/property values
 
+        self._app_root = app_root
         self._default_logging_level = self.logger.level
         self._configuration = None
         self._fieldnames = None
@@ -95,7 +100,7 @@ def logging_configuration(self):
     @logging_configuration.setter
     def logging_configuration(self, value):
         self.logger, self._logging_configuration = logging.configure(
-            type(self).__name__, value)
+            type(self).__name__, value, app_root=self._app_root)
         return
 
     @Option
@@ -274,9 +279,9 @@ def service(self):
 
     #region Methods
 
-    def error_exit(self, error):
-        self.logger.error('Abnormal exit: ' + error)
-        self.write_error(error)
+    def error_exit(self, error, message=None):
+        self.logger.error('Abnormal exit: %s', error)
+        self.write_error(error.message.capitalize() if message is None else message)
         exit(1)
 
     def process(self, args=argv, input_file=stdin, output_file=stdout):

splunklib/searchcommands/search_command_internals.py

@@ -275,8 +275,7 @@ def parse(self, argv, command):
 
         # Parse options
 
-        for option in SearchCommandParser._options_re.finditer(
-                command_args.group('options')):
+        for option in SearchCommandParser._options_re.finditer(command_args.group('options')):
             name, value = option.group(1), option.group(2)
             if not name in command.options:
                 raise ValueError('Unrecognized option: %s = %s' % (name, value))
@@ -288,9 +287,7 @@ def parse(self, argv, command):
             if len(missing) == 1:
                 raise ValueError('A value for "%s" is required' % missing[0])
             else:
-                raise ValueError(
-                    'Values for these options are required: %s' %
-                    ', '.join(missing))
+                raise ValueError('Values for these options are required: %s' % ', '.join(missing))
 
         # Parse field names
 
@@ -365,9 +362,9 @@ def replace(match):
 
     _options_re = re.compile(r"""
         # Captures a set of name/value pairs when used with re.finditer
-        ([_a-zA-Z][_a-zA-Z0-9]+)       # name
-        \s*=\s*                        # =
-        ([^\s"]+|"(?:[^"]+|""|\\")*")  # value
+        ([_a-zA-Z][_a-zA-Z0-9]+)         # name
+        \s*=\s*                          # =
+        ([^\s"]+|"(?:[^\\"]+|\\.|"")*")  # value
         """, re.VERBOSE)
 
     #endregion

splunklib/searchcommands/splunk_csv/dict_writer.py

@@ -63,7 +63,7 @@ def _encode_list(self, value):
         multi_value = ';'.join(
             ['$' + DictWriter._to_string(item).replace('$', '$$') + '$' for item
              in value])
-        value = self._mv_delimiter.join([repr(item) for item in value])
+        value = self._mv_delimiter.join([DictWriter._to_string(item) for item in value])
         return value, multi_value
 
     def _header_written(self):
@@ -73,8 +73,8 @@ def _header_written(self):
     def _to_string(item):
         if isinstance(item, bool):
             return 't' if item else 'f'
-        if isinstance(item, str):
-            return item
+        if isinstance(item, basestring):
+            return item.decode('utf-8')
         if isinstance(item, Number):
             return str(item)
         return repr(item)

splunklib/searchcommands/validators.py

@@ -22,7 +22,6 @@
 import re
 import sys
 
-
 class Validator(object):
     """ Base class for validators that check and format search command options.
 
@@ -123,12 +122,12 @@ def check_range(value):
         elif minimum is not None:
             def check_range(value):
                 if value < minimum:
-                    raise ValueError('Expected integer in the range [-∞,%d]: %d' % (maximum, value))
+                    raise ValueError('Expected integer in the range [%d,+∞]: %d' % (minimum, value))
                 return
         elif maximum is not None:
             def check_range(value):
                 if value > maximum:
-                    raise ValueError('Expected integer in the range [%d,+∞]: %d' % (minimum, value))
+                    raise ValueError('Expected integer in the range [-∞,%d]: %d' % (maximum, value))
                 return
         else:
             def check_range(value):
@@ -144,7 +143,7 @@ def __call__(self, value):
         return value
 
     def format(self, value):
-        return str(value)
+        return str(int(value))
 
 
 class Duration(Validator):
@@ -214,6 +213,24 @@ def format(self, value):
         return value[:-1]
 
 
+class Map(Validator):
+    """ Validates map option values.
+
+    """
+    def __init__(self, **kwargs):
+        self.membership = kwargs
+
+    def __call__(self, value):
+        if value is not None:
+            value = str(value)
+            if value not in self.membership:
+                raise ValueError('Unrecognized value: %s' % value)
+        return self.membership[value]
+
+    def format(self, value):
+        return self.membership.keys()[self.membership.values().index(value)]
+
+
 class OptionName(Validator):
     """ Validates option names.
 
@@ -226,6 +243,9 @@ def __call__(self, value):
             raise ValueError('Illegal characters in option name: %s' % value)
         return value
 
+    def format(self, value):
+        return self.__call__(value)
+
 
 class RegularExpression(Validator):
     """ Validates regular expression option values.
@@ -256,3 +276,6 @@ def __call__(self, value):
             if value not in self.membership:
                 raise ValueError('Unrecognized value: %s' % value)
         return value
+
+    def format(self, value):
+        return self.__call__(value)