Fixed tests for Python 2.6

* tests.searchcommands are skipped when running under Python 2.6
  Rationale:
  - Search commands require Splunk's Python which has been at 2.7 since Splunk 4.3
  - Search commands should be tested outside of splunk using "splunk cmd python <command-line>
* Test fixes eliminate (1) DeprecationWarning messages regarding use of BaseException.message and (2) a break introduced these past few days.
* TODO: Track down six cookie authentication failures, each with the same failure:
  AttributeError: 'TestCookieAuthentication' object has no attribute assertIsNotNone'
* VERIFIED: No Linux or OS X breaks on Python 2.7

Author: David Noble

.gitignore

@@ -22,4 +22,6 @@ examples/searchcommands_app/searchcommand_app.log
 Test Results*.html
 tests/searchcommands/data/app/app.log
 splunk_sdk.egg-info/
-dist/
+dist/
+examples/searchcommands_app/package/default/commands.conf
+examples/searchcommands_app/package/bin/packages

splunklib/modularinput/script.py

@@ -93,7 +93,7 @@ def run_script(self, args, event_writer, input_stream):
                     return 0
                 except Exception as e:
                     root = ET.Element("error")
-                    ET.SubElement(root, "message").text = e.message
+                    ET.SubElement(root, "message").text = str(e)
                     event_writer.write_xml_document(root)
 
                     return 1

tests/searchcommands/__init__.py

@@ -17,23 +17,29 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from os import path
-import logging
+from sys import version_info as python_version
 
-from splunklib.searchcommands import environment
-from splunklib import searchcommands
+if not (python_version[0] == 2 and python_version[1] == 7):
+    def load_tests(loader, tests, pattern):
+        return
+else:
+    from os import path
+    import logging
 
-package_directory = path.dirname(path.abspath(__file__))
-project_root = path.dirname(path.dirname(package_directory))
+    from splunklib.searchcommands import environment
+    from splunklib import searchcommands
 
+    package_directory = path.dirname(path.abspath(__file__))
+    project_root = path.dirname(path.dirname(package_directory))
 
-def rebase_environment(name):
 
-    environment.app_root = path.join(package_directory, 'apps', name)
-    logging.Logger.manager.loggerDict.clear()
-    del logging.root.handlers[:]
+    def rebase_environment(name):
 
-    environment.splunklib_logger, environment.logging_configuration = environment.configure_logging('splunklib')
-    searchcommands.logging_configuration = environment.logging_configuration
-    searchcommands.splunklib_logger = environment.splunklib_logger
-    searchcommands.app_root = environment.app_root
+        environment.app_root = path.join(package_directory, 'apps', name)
+        logging.Logger.manager.loggerDict.clear()
+        del logging.root.handlers[:]
+
+        environment.splunklib_logger, environment.logging_configuration = environment.configure_logging('splunklib')
+        searchcommands.logging_configuration = environment.logging_configuration
+        searchcommands.splunklib_logger = environment.splunklib_logger
+        searchcommands.app_root = environment.app_root

tests/test_all.py

@@ -18,11 +18,11 @@
 
 import os
 try:
-    import unittest2 as unittest
+    import unittest2 as unittest  # We must be sure to get unittest2--not unittest--on Python 2.6
 except ImportError:
     import unittest
-import testlib
 
+os.chdir(os.path.dirname(os.path.abspath(__file__)))
 suite = unittest.defaultTestLoader.discover('.')
 
 if __name__ == '__main__':

tests/test_binding.py

@@ -565,7 +565,7 @@ def test_login_fails_with_bad_cookie(self):
             new_context.get("apps/local")
             self.fail()
         except AuthenticationError as ae:
-            self.assertEqual(ae.message, "Request failed: Session is not logged in.")
+            self.assertEqual(str(ae), "Request failed: Session is not logged in.")
 
     def test_login_with_multiple_cookies(self):
         bad_cookie = 'bad=cookie'
@@ -575,7 +575,7 @@ def test_login_with_multiple_cookies(self):
             new_context.get("apps/local")
             self.fail()
         except AuthenticationError as ae:
-            self.assertEqual(ae.message, "Request failed: Session is not logged in.")
+            self.assertEqual(str(ae), "Request failed: Session is not logged in.")
             # Bring in a valid cookie now
             for key, value in self.context.get_cookies().items():
                 new_context.get_cookies()[key] = value
@@ -598,7 +598,8 @@ def test_login_fails_without_cookie_or_token(self):
             binding.connect(**opts)
             self.fail()
         except AuthenticationError as ae:
-            self.assertEqual(ae.message, "Login failed.")
+            self.assertEqual(str(ae), "Login failed.")
+
 
 class TestNamespace(unittest.TestCase):
     def test_namespace(self):

tests/test_examples.py

@@ -59,7 +59,7 @@ class ExamplesTestCase(testlib.SDKTestCase):
     def check_commands(self, *args):
         for arg in args:
             result = run(arg)
-            self.assertEquals(result, 0, '"{}" run failed with result code {}'.format(arg, result))
+            self.assertEquals(result, 0, '"{0}" run failed with result code {1}'.format(arg, result))
         self.service.login()  # Because a Splunk restart invalidates our session
 
     def setUp(self):

tests/test_job.py

@@ -27,7 +27,10 @@
 
 from splunklib.binding import _log_duration, HTTPError
 
-from xml.etree.ElementTree import ParseError
+# TODO: Determine if we should be importing ExpatError if ParseError is not avaialble (e.g., on Python 2.6)
+# There's code below that now catches SyntaxError instead of ParseError. Should we be catching ExpathError instead?
+
+# from xml.etree.ElementTree import ParseError
 
 
 class TestUtilities(testlib.SDKTestCase):
@@ -65,7 +68,7 @@ def test_export(self):
                             isinstance(ds[0], results.Message))
         nonmessages = [d for d in ds if isinstance(d, dict)]
         self.assertTrue(len(nonmessages) <= 3)
-    
+
     def test_export_docstring_sample(self):
         import splunklib.client as client
         import splunklib.results as results
@@ -79,7 +82,7 @@ def test_export_docstring_sample(self):
                 # Normal events are returned as dicts
                 pass #print result
         assert rr.is_preview == False
-    
+
     def test_results_docstring_sample(self):
         import splunklib.results as results
         service = self.service  # cheat
@@ -95,7 +98,7 @@ def test_results_docstring_sample(self):
                 # Normal events are returned as dicts
                 pass #print result
         assert rr.is_preview == False
-    
+
     def test_preview_docstring_sample(self):
         import splunklib.client as client
         import splunklib.results as results
@@ -113,7 +116,7 @@ def test_preview_docstring_sample(self):
             pass #print "Preview of a running search job."
         else:
             pass #print "Job is finished. Results are final."
-    
+
     def test_oneshot_docstring_sample(self):
         import splunklib.client as client
         import splunklib.results as results
@@ -274,8 +277,8 @@ def setUp(self):
         super(TestJob, self).setUp()
         self.query = "search index=_internal | head 3"
         self.job = self.service.jobs.create(
-            query=self.query, 
-            earliest_time="-1m", 
+            query=self.query,
+            earliest_time="-1m",
             latest_time="now")
 
     def tearDown(self):
@@ -324,7 +327,7 @@ def test_finalize(self):
     def test_setttl(self):
         old_ttl = int(self.job['ttl'])
         new_ttl = old_ttl + 1000
-        
+
         from datetime import datetime
         start_time = datetime.now()
         self.job.set_ttl(new_ttl)
@@ -362,7 +365,7 @@ def test_search_invalid_query_as_json(self):
         }
         try:
             self.service.jobs.create('invalid query', **args)
-        except ParseError as pe:
+        except SyntaxError as pe:
             self.fail("Something went wrong with parsing the REST API response. %s" % pe.message)
         except HTTPError as he:
             self.assertEqual(he.status, 400)
@@ -385,7 +388,7 @@ def test_results_reader(self):
                     from collections import OrderedDict
                 except:
                     from splunklib.ordereddict import OrderedDict
-                self.assertTrue(isinstance(r, OrderedDict) 
+                self.assertTrue(isinstance(r, OrderedDict)
                                 or isinstance(r, results.Message))
                 if isinstance(r, OrderedDict):
                     N_results += 1
@@ -407,7 +410,7 @@ def test_results_reader_with_streaming_results(self):
                     from collections import OrderedDict
                 except:
                     from splunklib.ordereddict import OrderedDict
-                self.assertTrue(isinstance(r, OrderedDict) 
+                self.assertTrue(isinstance(r, OrderedDict)
                                 or isinstance(r, results.Message))
                 if isinstance(r, OrderedDict):
                     N_results += 1

tests/test_service.py

@@ -214,7 +214,7 @@ def test_login_fails_with_bad_cookie(self):
             service2.apps.get()
             self.fail()
         except AuthenticationError as ae:
-            self.assertEqual(ae.message, "Request failed: Session is not logged in.")
+            self.assertEqual(str(ae), "Request failed: Session is not logged in.")
 
     def test_autologin_with_cookie(self):
         self.service.login()
@@ -237,7 +237,7 @@ def test_login_fails_with_no_cookie(self):
             service2.login()
             self.fail()
         except AuthenticationError as ae:
-            self.assertEqual(ae.message, "Login failed.")
+            self.assertEqual(str(ae), "Login failed.")
 
     def test_login_with_multiple_cookie_headers(self):
         cookies = {