Merge branch 'feature/scpv2' of https://git.splunk.com/scm/gitplay/splunk-sdk-python into feature/scpv2

Author: David Noble

CHANGELOG.md

@@ -4,11 +4,22 @@
 
 * Added support for Search Command Protocol V2, for Splunk 6.3+.
 
-* Added `splunklib` logger so that command loggers can be configured independently of the `splunklib.searchcommands` module.
+* Added support for invoking external search command processes.
+
+  See `examples/searchcommands_app/package/bin/pypygeneratext.py`.
+
+* Added a new search command type: EventingCommand is the base class for commands that filter events arriving at a
+  search head from one or more search peers.
+
+  See `examples/searchcommands_app/package/bin/filter.py`.
+
+* Added `splunklib` logger so that command loggers can be configured independently of the `splunklib.searchcommands`
+  module.
 
   See `examples/searchcommands_app/package/default/logger.conf` for guidance on logging configuration.
 
-* Added `splunklib.searchcommands.validators.Match` class for verifying that an option value matches a regular expression pattern.
+* Added `splunklib.searchcommands.validators.Match` class for verifying that an option value matches a regular
+  expression pattern.
 
 ### Bug fixes
 

examples/searchcommands_app/package/bin/_pydebug_conf.py

@@ -15,6 +15,6 @@
 # under the License.
 
 host = 'localhost'
-port = 52001
+port = 5678
 suspend = False
 is_enabled = {}

examples/searchcommands_app/setup.py

@@ -455,6 +455,7 @@ def run(self):
             os.path.join('package', 'bin', 'countmatches.py'),
             os.path.join('package', 'bin', 'filter.py'),
             os.path.join('package', 'bin', 'generatehello.py'),
+            os.path.join('package', 'bin', 'generatetext.py'),
             os.path.join('package', 'bin', 'pypygeneratetext.py'),
             os.path.join('package', 'bin', 'simulate.py'),
             os.path.join('package', 'bin', 'sum.py')

tests/searchcommands/test_search_command.py

@@ -393,7 +393,7 @@ def test_process_scpv2(self):
 
         getinfo_metadata = metadata.format(
             dispatch_dir=encode_string(dispatch_dir),
-            logging_configuration=logging_configuration,
+            logging_configuration=encode_string(logging_configuration)[1:-1],
             logging_level=logging_level,
             record=('true' if record is True else 'false'),
             show_configuration=('true' if show_configuration is True else 'false'))
@@ -407,7 +407,7 @@ def test_process_scpv2(self):
 
         command = TestCommand()
         result = StringIO()
-        argv = ['test.py']
+        argv = ['some-external-search-command.py']
 
         self.assertEqual(command.logging_configuration, default_logging_configuration)
         self.assertEqual(command.logging_level, 'WARNING')
@@ -584,7 +584,7 @@ def test_process_scpv2(self):
 
         getinfo_metadata = metadata.format(
             dispatch_dir=encode_string(dispatch_dir),
-            logging_configuration=logging_configuration,
+            logging_configuration=encode_string(logging_configuration)[1:-1],
             logging_level=logging_level,
             record=record,
             show_configuration=show_configuration)
@@ -631,7 +631,7 @@ def test_process_scpv2(self):
 
         getinfo_metadata = metadata.format(
             dispatch_dir=encode_string(dispatch_dir),
-            logging_configuration=logging_configuration,
+            logging_configuration=encode_string(logging_configuration)[1:-1],
             logging_level=logging_level,
             record=('true' if record is True else 'false'),
             show_configuration=('true' if show_configuration is True else 'false'))

tests/searchcommands/test_searchcommands_app.py

@@ -250,7 +250,7 @@ def assertInfoEqual(self, output, expected):
     def _get_search_command_path(self, name):
         path = os.path.join(
             project_root, 'examples', 'searchcommands_app', 'build', 'searchcommands_app', 'bin', name + '.py')
-        self.assertTrue(path)
+        self.assertTrue(os.path.isfile(path))
         return path
 
     def _run_command(self, name, action=None, phase=None, protocol=2):