Release 1.6.1

Author: Shakeel Mohamed

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.6.1
+
+### Bug Fixes
+
+* Fixed Search Commands exiting if the external process returns a zero status code (Windows only).
+
+* Fixed Search Command Protocol v2 not parsing the `maxresultrows` and `command` metadata properties.
+
+* Fixed double prepending the `Splunk ` prefix for authentication tokens.
+
+* Fixed `Index.submit()` for namespaced `Service` instances.
+
+* Fixed uncaught `AttributeError` when accessing `Entity` properties (GitHub issue #131).
+
+### Minor Changes
+
+* Fixed broken tests due to expired SSL certificate.
+
 ## Version 1.6.0
 
 ### New Features and APIs

README.md

@@ -1,7 +1,7 @@
 [![Build Status](https://travis-ci.org/splunk/splunk-sdk-python.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-python)
 # The Splunk Software Development Kit for Python
 
-#### Version 1.6.0
+#### Version 1.6.1
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.

examples/handlers/cacert.pem

@@ -1,16 +1,16 @@
 -----BEGIN CERTIFICATE-----
-MIICdTCCAd4CCQDAsfQhOfrWaTANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJV
-UzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDVNhbiBGcmFuY2lzY28xDzANBgNVBAoT
-BlNwbHVuazEXMBUGA1UEAxMOU3BsdW5rQ29tbW9uQ0ExITAfBgkqhkiG9w0BCQEW
-EnN1cHBvcnRAc3BsdW5rLmNvbTAeFw0wNjA3MjQxNzEyMTlaFw0xNjA3MjExNzEy
-MTlaMH8xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNU2FuIEZy
-YW5jaXNjbzEPMA0GA1UEChMGU3BsdW5rMRcwFQYDVQQDEw5TcGx1bmtDb21tb25D
+MIICdTCCAd4CCQDlsvzBaZf1RjANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJV
+UzELMAkGA1UECAwCQ0ExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDzANBgNVBAoM
+BlNwbHVuazEXMBUGA1UEAwwOU3BsdW5rQ29tbW9uQ0ExITAfBgkqhkiG9w0BCQEW
+EnN1cHBvcnRAc3BsdW5rLmNvbTAeFw0xNTA1MTExOTUxMzdaFw0yNTA1MDgxOTUx
+MzdaMH8xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJDQTEWMBQGA1UEBwwNU2FuIEZy
+YW5jaXNjbzEPMA0GA1UECgwGU3BsdW5rMRcwFQYDVQQDDA5TcGx1bmtDb21tb25D
 QTEhMB8GCSqGSIb3DQEJARYSc3VwcG9ydEBzcGx1bmsuY29tMIGfMA0GCSqGSIb3
 DQEBAQUAA4GNADCBiQKBgQDJmb55yvam1GqGgTK0dfHXWJiB0Fh8fsdJFRc5dxBJ
 PFaC/klmtbLFLbYuXdC2Jh4cm/uhj1/FWmA0Wbhb02roAV03Z3SX0pHyFa3Udyqr
 9f5ERJ0AYFA+y5UhbMnD9zlhs7J8ucub3XvA8rn79ejkYtDX2rMQWPNZYPcrxUEh
-iwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAKW37NFwTikJOMo9Z8cjmJDz9wa4yckB
-MlEA1/s6k6OmzZH0gkAssLstRkBavlr1uIBPZ2Jfse6FjoJ5ekC1AoXkInwmCspW
-GTVCoe8rwhU0xaj0GsC+wA3ykL+UKuXz6iE3oDcnLr0qxiNT2OxdTxz+EB9T0ynR
-x/F2KL1hdfCR
+iwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAFd9dzyyb2wnlDy3tlFVH2BUXdJZPKIC
+E3VyMsPTNhXDq7ESVWBLJeUQh6uJ1A3QyLrtTqG/1h62vvP+UxAw4THZ4g3a2i65
+3T1q78dhq1cKneOuE83Te/fREH54QokzrnAXoz+v/aGJkzjEpSEwrWUwLA1koE8I
+/0XFEwxWbEbt
 -----END CERTIFICATE-----

examples/searchcommands_app/setup.py

@@ -432,7 +432,7 @@ def run(self):
     setup(
         description='Custom Search Command examples',
         name=os.path.basename(project_dir),
-        version='1.6.0',
+        version='1.6.1',
         author='Splunk, Inc.',
         author_email='devinfo@splunk.com',
         url='http://github.com/splunk/splunk-sdk-python',

splunklib/__init__.py

@@ -14,6 +14,6 @@
 
 """Python library for Splunk."""
 
-__version_info__ = (1, 6, 0)
+__version_info__ = (1, 6, 1)
 __version__ = ".".join(map(str, __version_info__))
 

splunklib/binding.py

@@ -1343,7 +1343,7 @@ def request(url, message, **kwargs):
         head = {
             "Content-Length": str(len(body)),
             "Host": host,
-            "User-Agent": "splunk-sdk-python/1.6.0",
+            "User-Agent": "splunk-sdk-python/1.6.1",
             "Accept": "*/*",
             "Connection": "Close",
         } # defaults

splunklib/client.py

@@ -67,7 +67,7 @@
 import socket
 import contextlib
 
-from binding import Context, HTTPError, AuthenticationError, namespace, UrlEncoded, _encode, _make_cookie_header
+from binding import Context, HTTPError, AuthenticationError, namespace, UrlEncoded, _encode, _make_cookie_header, _NoAuthenticationToken
 from data import record
 import data
 
@@ -100,8 +100,8 @@
 PATH_SAVED_SEARCHES = "saved/searches/"
 PATH_STANZA = "configs/conf-%s/%s" # (file, stanza)
 PATH_USERS = "authentication/users/"
-PATH_RECEIVERS_STREAM = "receivers/stream"
-PATH_RECEIVERS_SIMPLE = "receivers/simple"
+PATH_RECEIVERS_STREAM = "/services/receivers/stream"
+PATH_RECEIVERS_SIMPLE = "/services/receivers/simple"
 PATH_STORAGE_PASSWORDS = "storage/passwords"
 
 XNAMEF_ATOM = "{http://www.w3.org/2005/Atom}%s"
@@ -884,7 +884,7 @@ def __contains__(self, item):
         try:
             self[item]
             return True
-        except KeyError:
+        except KeyError, AttributeError:
             return False
 
     def __eq__(self, other):
@@ -1937,7 +1937,9 @@ def attach(self, host=None, source=None, sourcetype=None):
         if sourcetype is not None: args['sourcetype'] = sourcetype
         path = UrlEncoded(PATH_RECEIVERS_STREAM + "?" + urllib.urlencode(args), skip_encode=True)
 
-        cookie_or_auth_header = "Authorization: %s\r\n" % self.service.token
+        cookie_or_auth_header = "Authorization: Splunk %s\r\n" % \
+                                (self.service.token if self.service.token is _NoAuthenticationToken
+                                 else self.service.token.replace("Splunk ", ""))
 
         # If we have cookie(s), use them instead of "Authorization: ..."
         if self.service.has_cookies():

splunklib/searchcommands/external_search_command.py

@@ -142,7 +142,9 @@ def terminate_child():
             p.wait()
 
             logger.debug('finished command="%s", arguments=%s, pid=%d, returncode=%d', path, argv, p.pid, p.returncode)
-            sys.exit(p.returncode)
+
+            if p.returncode != 0:
+                sys.exit(p.returncode)
 
         @staticmethod
         def _search_path(executable, paths):

splunklib/searchcommands/search_command.py

@@ -684,7 +684,7 @@ def _process_protocol_v2(self, argv, ifile, ofile):
         # Write search command configuration for consumption by splunkd
         # noinspection PyBroadException
         try:
-            self._record_writer = RecordWriterV2(ofile, getattr(self._metadata, 'maxresultrows', None))
+            self._record_writer = RecordWriterV2(ofile, getattr(self._metadata.searchinfo, 'maxresultrows', None))
             self.fieldnames = []
             self.options.reset()
 

tests/searchcommands/test_search_command.py

@@ -378,7 +378,9 @@ def test_process_scpv2(self):
                         '"show_configuration={show_configuration}",'
                         '"required_option_1=value_1",'
                         '"required_option_2=value_2"'
-                    ']'
+                    '],'
+                    '"maxresultrows": 10,'
+                    '"command": "countmatches"'
                 '}}'
             '}}')
 
@@ -472,6 +474,8 @@ def test_process_scpv2(self):
         self.assertEqual(command_metadata.searchinfo.splunk_version, '20150522')
         self.assertEqual(command_metadata.searchinfo.splunkd_uri, 'https://127.0.0.1:8089')
         self.assertEqual(command_metadata.searchinfo.username, 'admin')
+        self.assertEqual(command_metadata.searchinfo.maxresultrows, 10)
+        self.assertEqual(command_metadata.searchinfo.command, 'countmatches')
 
         command.search_results_info.search_metrics = command.search_results_info.search_metrics.__dict__
         command.search_results_info.optional_fields_json = command.search_results_info.optional_fields_json.__dict__