Resolves https://jira.splunk.com/browse/DVPL-3641

splunklib.searchcommands | Writing messages header causes Getinfo probe failure

CAUSE:
+ outputheader=true must be set in commands.conf
+ messages header may only be sent during __EXECUTE__ phase, not __GETINFO__ phase.

TODO:
+ Issue feature ask for the search team: outputheader can be specified dynamically.

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

Author: David Noble

examples/searchcommands_app/default/commands.conf

@@ -10,6 +10,7 @@ supports_rawargs = true
 filename = simulate.py
 supports_getinfo = true
 supports_rawargs = true
+outputheader = true
 
 [sum]
 filename = sum.py

splunklib/searchcommands/search_command.py

@@ -28,16 +28,17 @@
 # Relative imports
 
 from . import csv, logging
-from . decorators import Option
-from . validators import Boolean, Fieldname
-from . search_command_internals import InputHeader, MessagesHeader, \
+from .decorators import Option
+from .validators import Boolean, Fieldname
+from .search_command_internals import InputHeader, MessagesHeader, \
     SearchCommandParser
 
 
 class SearchCommand(object):
     """ Represents a custom search command
 
     """
+
     def __init__(self):
 
         # Variables that may be used, but not altered by derived classes
@@ -102,14 +103,14 @@ def __str__(self):
     #         value = self._default_logging_level
     #     self.logger.setLevel(value)
     #     return
-    #
-    # show_configuration = Option(doc='''
-    #     **Syntax:** show_configuration=<bool>
-    #
-    #     **Description:** When `true`, reports command configuration in the
-    #     messages header for this command invocation. Defaults to `false`.
-    #
-    #     ''', default=False, validate=Boolean())
+
+    show_configuration = Option(doc='''
+        **Syntax:** show_configuration=<bool>
+
+        **Description:** When `true`, reports command configuration in the
+        messages header for this command invocation. Defaults to `false`.
+
+        ''', default=False, validate=Boolean())
     #
     # #endregion
 
@@ -159,10 +160,9 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
                 writer.writerow({'ERROR': e})
                 self.logger.error(e)
                 return
+
             self._configuration = ConfigurationSettings(self)
-            # Disabled in splunk-sdk-python-1.2.0 due to known issues
-            # if self.show_configuration:
-            #     self.messages.append('info_message', str(self._configuration))
+
             writer = csv.DictWriter(
                 output_file, self, self.configuration.keys(), mv_delimiter=',')
             writer.writerow(self.configuration.items())
@@ -182,6 +182,12 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
                 return
 
             self._configuration = ConfigurationSettings(self)
+
+            if self.show_configuration:
+                self.messages.append('info_message',
+                                     '%s command configuration settings: %s' %
+                                     (self.name, self._configuration))
+
             writer = csv.DictWriter(output_file, self)
             self._execute(operation, reader, writer)
 
@@ -218,6 +224,7 @@ class ConfigurationSettings(object):
         :class:`SearchCommand` classes.
 
         """
+
         def __init__(self, command):
             self.command = command
 
@@ -230,8 +237,8 @@ def __str__(self):
             :return: String representation of this instance
 
             """
-            text = '\n'.join(
-                ['%s = %s' % (k, getattr(self, k)) for k in self.keys()])
+            text = ', '.join(
+                ['%s=%s' % (k, getattr(self, k)) for k in self.keys()])
             return text
 
         #region Properties
@@ -511,4 +518,4 @@ def keys(self):
 
         #endregion
 
-    #endregion
+        #endregion

splunklib/searchcommands/search_command_internals.py

@@ -169,10 +169,8 @@ def write(self, output_file):
         by a pair of '\r\n' sequences.
 
         """
-        # Disabled in splunk-sdk-python-1.2.0 due to known issues
-        # for level, message in self:
-        #     output_file.write('%s=%s\r\n' % (level, message))
-        self
+        for level, message in self:
+            output_file.write('%s=%s\r\n' % (level, message))
         output_file.write('\r\n')
 
 

…es/searchcommands_app/bin/population.csv …searchcommands_data/input/population.csvexamples/searchcommands_app/bin/population.csv renamed to tests/searchcommands_data/input/population.csv examples/searchcommands_app/bin/population.csv renamed to tests/searchcommands_data/input/population.csv

@@ -298,7 +298,7 @@ def disable_test_option_logging_level(self):
                 os.path.join('log', 'test_option_logging_level.log')))
         return
 
-    def disable_test_option_show_configuration(self):
+    def test_option_show_configuration(self):
         self._run(
             'simulate', [
                 'csv=population.csv',
@@ -307,7 +307,7 @@ def disable_test_option_show_configuration(self):
                 'rate=200',
                 'seed=%s' % TestSearchCommandsApp._seed,
                 'show_configuration=true'],
-            __GETINFO__=(
+            __EXECUTE__=(
                 os.path.join('input', '_empty.csv'),
                 os.path.join('output', 'test_option_show_configuration.csv'),
                 os.path.join('log', 'test_option_show_configuration.log')))
@@ -327,7 +327,7 @@ def test_generating_command_in_isolation(self):
                 'csv=population.csv',
                 'duration=00:00:02',
                 'interval=00:00:01',
-                'rate=200',
+                'rate=50',
                 'seed=%s' % TestSearchCommandsApp._seed],
             __GETINFO__=(
                 os.path.join('input', '_empty.csv'),