Merge branch 'master' into develop

Author: Shakeel Mohamed

.gitignore

@@ -5,6 +5,7 @@
 *coverage_html_report*
 .coverage
 .coverage.*
+.python-version
 __stdout__
 docs/_build
 build/
@@ -18,4 +19,5 @@ examples/*/metadata
 tests/searchcommands_data/log/
 tests/searchcommands_data/output/
 examples/searchcommands_app/searchcommand_app.log
-Test Results*.html
+Test Results*.html
+tests/searchcommands/data/app/app.log

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Splunk SDK for Python Changelog
 
+## Version 1.3.1
+
+### Bug fixes
+
+* Hot fix to `binding.py` to work with Python 2.7.9, which introduced SSL certificate validation by default as outlined in [PEP 476](https://www.python.org/dev/peps/pep-0476).
+* Update `async`, `handler_proxy`, and `handler_urllib2` examples to work with Python 2.7.9 by disabling SSL certificate validation by default.
 
 ## Version 1.3.0
 

README.md

@@ -1,6 +1,6 @@
 # The Splunk Software Development Kit for Python
 
-#### Version 1.3.0
+#### Version 1.3.1
 
 The Splunk Software Development Kit (SDK) for Python contains library code and 
 examples designed to enable developers to build applications using Splunk.

examples/async/async.py

@@ -22,6 +22,7 @@
 
 import sys, os, datetime
 import urllib
+import ssl
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))
 
 import splunklib.binding as binding
@@ -171,7 +172,12 @@ def request(url, message, **kwargs):
     method = message.get("method", "GET")
 
     # Note that we do not support proxies in this example
-    opener = urllib2.build_opener()
+    # If running Python 2.7.9+, disable SSL certificate validation
+    if sys.version_info >= (2, 7, 9):
+        unverified_ssl_handler = urllib2.HTTPSHandler(context=ssl._create_unverified_context())
+        opener = urllib2.build_opener(unverified_ssl_handler)
+    else:
+        opener = urllib2.build_opener()
 
     # Unfortunately, we need to use the hack of 
     # "overriding" `request.get_method` to specify

examples/handlers/handler_proxy.py

@@ -29,6 +29,7 @@
 from pprint import pprint
 from StringIO import StringIO
 import sys, os
+import ssl
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))
 import urllib2
 
@@ -52,9 +53,15 @@ def request(url, message, **kwargs):
     method = message['method'].lower()
     data = message.get('body', "") if method == 'post' else None
     headers = dict(message.get('headers', []))
-    context = urllib2.Request(url, data, headers)
+    req = urllib2.Request(url, data, headers)
     try:
-        response = urllib2.urlopen(context)
+        response = urllib2.urlopen(req)
+    except urllib2.URLError, response:
+        # If running Python 2.7.9+, disable SSL certificate validation and try again
+        if sys.version_info >= (2, 7, 9):
+            response = urllib2.urlopen(req, context=ssl._create_unverified_context())
+        else:
+            raise
     except urllib2.HTTPError, response:
         pass # Propagate HTTP errors via the returned response message
     return {

examples/handlers/handler_urllib2.py

@@ -21,6 +21,7 @@
 import sys, os
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))
 import urllib2
+import ssl
 
 import splunklib.client as client
 
@@ -34,9 +35,13 @@ def request(url, message, **kwargs):
     method = message['method'].lower()
     data = message.get('body', "") if method == 'post' else None
     headers = dict(message.get('headers', []))
-    context = urllib2.Request(url, data, headers)
+    # If running Python 2.7.9+, disable SSL certificate validation
+    req = urllib2.Request(url, data, headers)
     try:
-        response = urllib2.urlopen(context)
+        if sys.version_info >= (2, 7, 9):
+            response = urllib2.urlopen(req, context=ssl._create_unverified_context())
+        else:
+            response = urllib2.urlopen(req)
     except urllib2.HTTPError, response:
         pass # Propagate HTTP errors via the returned response message
     return {

setup.py

@@ -34,6 +34,17 @@ def run_test_suite():
     unittest.TextTestRunner().run(suite)
     os.chdir(original_cwd)
 
+def run_test_suite_with_junit_output():
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
+    import xmlrunner
+    original_cwd = os.path.abspath(os.getcwd())
+    os.chdir('tests')
+    suite = unittest.defaultTestLoader.discover('.')
+    xmlrunner.XMLTestRunner(output='../test-reports').run(suite)
+    os.chdir(original_cwd)
 
 class CoverageCommand(Command):
     """setup.py command to run code coverage of the test suite."""
@@ -73,6 +84,20 @@ def finalize_options(self):
     def run(self):
         run_test_suite()
 
+class JunitXmlTestCommand(Command):
+    """setup.py command to run the whole test suite."""
+    description = "Run test full test suite with JUnit-formatted output."
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        run_test_suite_with_junit_output()
+
 
 class DistCommand(Command):
     """setup.py command to create .spl files for modular input and search
@@ -175,6 +200,7 @@ def exclude(path):
 
     cmdclass={'coverage': CoverageCommand,
               'test': TestCommand,
+              'testjunit': JunitXmlTestCommand,
               'dist': DistCommand},
 
     description="The Splunk Software Development Kit for Python.",
@@ -202,4 +228,4 @@ def exclude(path):
         "Topic :: Software Development :: Libraries :: Python Modules",
         "Topic :: Software Development :: Libraries :: Application Frameworks",
     ],
-)
+)

splunklib/__init__.py

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

splunklib/binding.py

@@ -30,6 +30,7 @@
 import ssl
 import urllib
 import io
+import sys
 
 from datetime import datetime
 from functools import wraps
@@ -1204,6 +1205,10 @@ def connect(scheme, host, port):
         if scheme == "https":
             if key_file is not None: kwargs['key_file'] = key_file
             if cert_file is not None: kwargs['cert_file'] = cert_file
+
+            # If running Python 2.7.9+, disable SSL certificate validation
+            if sys.version_info >= (2,7,9) and key_file is None and cert_file is None:
+                kwargs['context'] = ssl._create_unverified_context()
             return httplib.HTTPSConnection(host, port, **kwargs)
         raise ValueError("unsupported scheme: %s" % scheme)
 

tests/test_binding.py

@@ -24,6 +24,8 @@
 import testlib
 import unittest
 import socket
+import sys
+import ssl
 
 import splunklib.binding as binding
 from splunklib.binding import HTTPError, AuthenticationError, UrlEncoded
@@ -435,9 +437,13 @@ def urllib2_handler(url, message, **kwargs):
     method = message['method'].lower()
     data = message.get('body', "") if method == 'post' else None
     headers = dict(message.get('headers', []))
-    context = urllib2.Request(url, data, headers)
+    req = urllib2.Request(url, data, headers)
     try:
-        response = urllib2.urlopen(context)
+        # If running Python 2.7.9+, disable SSL certificate validation
+        if sys.version_info >= (2, 7, 9):
+            response = urllib2.urlopen(req, context=ssl._create_unverified_context())
+        else:
+            response = urllib2.urlopen(req)
     except urllib2.HTTPError, response:
         pass # Propagate HTTP errors via the returned response message
     return {