use an app_root parameter for SearchCommand and Logging.configure to handle tests

Author: Shakeel Mohamed

examples/searchcommands_app/bin/simulate.py

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

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,64 +59,67 @@ 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
 
     """
-    # TODO: verify that reverting to this, instead of using sys.argv[0] works
-    app_directory = os.path.dirname(os.getcwd())
+    if app_root:
+        print "app_root is " + app_root
+    app_directory = get_app_directory(sys.argv[0]) if app_root is None else app_root
 
-    if path is None:
-        probing_path = [
+    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

tests/searchcommands/test_decorators.py

@@ -117,8 +117,8 @@ def test_builtin_options(self):
 
             # A search command loads {local,default}/logging.conf when it is
             # available
-
-            command = SearchCommand()  # guarantee: default/logging.conf
+            command = SearchCommand(
+                app_root=app_root)  # guarantee: default/logging.conf
             self.assertEqual(command.logging_configuration,
                              default_logging_configuration)