Merge branch 'develop' into bug/DVPL-7204-distributed-search

Author: dan1

examples/searchcommands_app/package/default/searchbnf.conf

@@ -36,7 +36,7 @@ comment1 = \
 example1 = \
     | generatetext text="Hello world! How the heck are you?" count=6 \
         | filter predicate="(long(_serial) & 1) == 0" map="_raw = _raw.replace('world', 'Splunk')"
-category = eventing
+category = events
 appears-in = 1.5
 maintainer = dnoble
 usage = public

splunklib/searchcommands/eventing_command.py

@@ -113,10 +113,10 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
 
             ''')
 
-        type = ConfigurationSetting(readonly=True, value='eventing', doc='''
+        type = ConfigurationSetting(readonly=True, value='events', doc='''
             Command type
 
-            Fixed: :const:`'eventing'`.
+            Fixed: :const:`'events'`.
 
             Supported by: SCP 2
 

splunklib/searchcommands/generating_command.py

@@ -56,7 +56,7 @@ class GeneratingCommand(SearchCommand):
     +==========+=====================================+============================================+
     | streams  | streaming=True[,local=[True|False]] | type='streaming'[,distributed=[true|false] |
     +----------+-------------------------------------+--------------------------------------------+
-    | events   | retainsevents=True, streaming=False | type='eventing'                            |
+    | events   | retainsevents=True, streaming=False | type='events'                              |
     +----------+-------------------------------------+--------------------------------------------+
     | reports  | streaming=False                     | type='reporting'                           |
     +----------+-------------------------------------+--------------------------------------------+
@@ -112,7 +112,7 @@ class StreamingGeneratingCommand(GeneratingCommand)
     |          | settings to your command class:                   | setting to your command class:                    |
     |          |                                                   |                                                   |
     |          | .. code-block:: python                            | .. code-block:: python                            |
-    |          |     @Configuration(                               |     @Configuration(type='eventing')               |
+    |          |     @Configuration(                               |     @Configuration(type='events')                 |
     |          |         retainsevents=True, streaming=False)      |     class SomeCommand(GeneratingCommand)          |
     |          |     class SomeCommand(GeneratingCommand)          |         ...                                       |
     |          |         ...                                       |                                                   |
@@ -127,7 +127,7 @@ class StreamingGeneratingCommand(GeneratingCommand)
     Configure your command class like this, if you wish to support both protocols:
 
     .. code-block:: python
-        @Configuration(type='eventing', retainsevents=True, streaming=False)
+        @Configuration(type='events', retainsevents=True, streaming=False)
         class SomeCommand(GeneratingCommand)
             ...
 
@@ -193,6 +193,18 @@ def _execute(self, ifile, process):
         :return: `None`.
 
         """
+        if self._protocol_version == 2:
+            result = self._read_chunk(ifile)
+
+            if not result:
+                return
+
+            metadata, body = result
+            action = getattr(metadata, 'action', None)
+
+            if action != 'execute':
+                raise RuntimeError('Expected execute action, not {}'.format(action))
+
         self._record_writer.write_records(self.generate())
         self.finish()
 
@@ -280,7 +292,7 @@ class ConfigurationSettings(SearchCommand.ConfigurationSettings):
             ====================  ======================================================================================
             Value                 Description
             --------------------  --------------------------------------------------------------------------------------
-            :const:`'eventing'`   Runs as the first command in the Splunk events pipeline. Cannot be distributed.
+            :const:`'events'`     Runs as the first command in the Splunk events pipeline. Cannot be distributed.
             :const:`'reporting'`  Runs as the first command in the Splunk reports pipeline. Cannot be distributed.
             :const:`'streaming'`  Runs as the first command in the Splunk streams pipeline. May be distributed.
             ====================  ======================================================================================

splunklib/searchcommands/internals.py

@@ -326,7 +326,7 @@ def validate_configuration_setting(specification, name, value):
             supporting_protocols=[1, 2]),
         'type': specification(
             type=(bytes, unicode),
-            constraint=lambda value: value in ('eventing', 'reporting', 'streaming'),
+            constraint=lambda value: value in ('events', 'reporting', 'streaming'),
             supporting_protocols=[2])}
 
 

splunklib/searchcommands/search_command.py

@@ -19,6 +19,7 @@
 # Absolute imports
 
 from collections import namedtuple
+
 try:
     from collections import OrderedDict  # must be python 2.7
 except ImportError:
@@ -27,6 +28,7 @@
 from cStringIO import StringIO
 from itertools import chain, ifilter, imap, islice, izip
 from logging import _levelNames, getLevelName, getLogger
+
 try:
     from shutil import make_archive
 except ImportError:
@@ -47,7 +49,7 @@
 
 # Relative imports
 
-from . internals import (
+from .internals import (
     CommandLineParser,
     CsvDialect,
     InputHeader,
@@ -63,6 +65,7 @@
 from . import Boolean, Option, environment
 from ..client import Service
 
+
 # ----------------------------------------------------------------------------------------------------------------------
 
 # P1 [ ] TODO: Log these issues against ChunkedExternProcessor
@@ -89,6 +92,7 @@ class SearchCommand(object):
     """ Represents a custom search command.
 
     """
+
     def __init__(self):
 
         # Variables that may be used, but not altered by derived classes
@@ -873,8 +877,10 @@ def _read_chunk(ifile):
         # if body_length <= 0:
         #     return metadata, ''
 
+        body = ""
         try:
-            body = ifile.read(body_length)
+            if body_length > 0:
+                body = ifile.read(body_length)
         except Exception as error:
             raise RuntimeError('Failed to read body of length {}: {}'.format(body_length, error))