Merge pull request #58 from splunk/feature/2.6.1

Test suite now runs and passes on Python 2.6

Author: Fred Ross

README.md

@@ -141,10 +141,18 @@ away some of the lower level details of the _binding_ layer.
 ### Unit tests
 
 The SDK contains a small but growing collection of unit tests. Running the
-tests is simple and rewarding:
+tests is simple and rewarding. If you are using Python 2.7, the test suite
+will run using only Python's standard library. If you are using Python 2.6,
+you need to install the `unittest2` library, since the test suite depends on
+features added to `unittest` in Python 2.7. `unittest2` is only needed for
+the running test suite, not for using the SDK.
 
-> cd tests<br>
-> python runtests.py
+To run the test suite, run the following command in the top level directory
+of the SDK repository:
+
+> python setup.py test
+
+You can also run the test_all.py script in the tests/ directory.
 
 Alternatively, you can read more about our testing "framework" 
 [here](https://github.com/splunk/splunk-sdk-python/tree/master/tests).

setup.py

@@ -19,7 +19,10 @@
 import splunklib
 
 def run_test_suite():
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     original_cwd = os.path.abspath(os.getcwd())
     os.chdir('tests')
     suite = unittest.defaultTestLoader.discover('.')

splunklib/client.py

@@ -1688,9 +1688,15 @@ def _entity_path(self, state):
 
 class Stanza(Entity):
     """This class contains a single configuration stanza."""
+
     def submit(self, stanza):
         """Sets the keys in *stanza* this Stanza.
 
+        *stanza* will usually be a dictionary of key/value pairs, but can also
+        by a raw string to send as the POST body of the request (e.g.,
+        `"key=some+value&other+key=another+value"`). Sending raw strings should
+        be considered deprecated.
+
         :param stanza: A dictionary of key/value pairs to set in this stanza.
         :type stanza: ``dict``
         :return: The :class:`Stanza` object this method is called on.
@@ -2472,7 +2478,7 @@ def oneshot(self, path, **kwargs):
             self.post('oneshot', name=path, **kwargs)
         except HTTPError as he:
             if he.status == 400:
-                raise OperationFailedException(he.message)
+                raise OperationFailedException(str(he))
             else:
                 raise
 
@@ -2848,7 +2854,7 @@ def create(self, query, **kwargs):
             response = self.post(search=query, **kwargs)
         except HTTPError as he:
             if he.status == 400: # Bad request. Raise a TypeError with the reason.
-                raise TypeError(he.message)
+                raise TypeError(str(he))
         sid = _load_sid(response)
         return Job(self.service, sid)
 

tests/README.md

@@ -22,6 +22,10 @@ fetch it from `https://github.com/splunk/sdk-app-collection`. Put the
 whole repository in `$SPLUNK_HOME/etc/apps`, so the git root would be
 `$SPLUNK_HOME/etc/apps/sdk-app-collection`.
 
+If you are running Python 2.6, you must install the `unittest2` library,
+since the test suite depends on features added to `unittest` in Python 2.7.
+Python 2.7 should run the test suite using only Python's standard library.
+
 The test suite depends on nothing but Python's standard library. You can
 simply execute:
 

tests/test_all.py

@@ -17,7 +17,10 @@
 """Runs all the Splunk Python SDK unit tests."""
 
 import os
-import unittest
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
 import testlib
 
 suite = unittest.defaultTestLoader.discover('.')

tests/test_app.py

@@ -99,5 +99,8 @@ def test_updateInfo(self):
         self.assertTrue(p is not None)
 
 if __name__ == "__main__":
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     unittest.main()

tests/test_binding.py

@@ -581,7 +581,9 @@ def test_connect_with_preexisting_token_sans_user_and_pass(self):
         socket.write("\r\n")
         socket.close()
 
-        
 if __name__ == "__main__":
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     unittest.main()

tests/test_collection.py

@@ -240,6 +240,9 @@ def test_getitem_with_nonsense(self):
             self.assertRaises(KeyError, coll.__getitem__, name)
 
 if __name__ == "__main__":
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     unittest.main()
 

tests/test_conf.py

@@ -92,6 +92,13 @@ def test_confs(self):
             self.assertTrue(key in stanza)
             self.assertEqual(value, stanza[key])
 
+        key2 = testlib.tmpname()
+        val2 = testlib.tmpname()
+        stanza.submit("%s=%s&%s=%s" % (key2, val2, key2, val2))
+        stanza.refresh()
+        self.assertTrue(key2 in stanza)
+        self.assertEqual(val2, stanza[key2])
+
         count = len(conf)
         conf.delete(stanza_name)
         self.assertFalse(stanza_name in conf)
@@ -103,5 +110,8 @@ def test_confs(self):
         self.assertTrue(conf_name in confs)
 
 if __name__ == "__main__":
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     unittest.main()

tests/test_data.py

@@ -14,6 +14,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import sys
 from os import path
 import xml.etree.ElementTree as et
 
@@ -114,7 +115,12 @@ def test_real(self):
         self.assertEqual(result.feed.entry.content.os_version, '10.8.0')
 
     def test_invalid(self):
-        self.assertRaises(et.ParseError, data.load, "<dict</dict>")
+        if sys.version_info[1] >= 7:
+            self.assertRaises(et.ParseError, data.load, "<dict</dict>")
+        else:
+            from xml.parsers.expat import ExpatError
+            self.assertRaises(ExpatError, data.load, "<dict</dict>")
+            
         self.assertRaises(KeyError, data.load, "<dict><key>a</key></dict>")
 
     def test_dict(self):
@@ -240,6 +246,9 @@ def test_record(self):
 
 
 if __name__ == "__main__":
-    import unittest
+    try:
+        import unittest2 as unittest
+    except ImportError:
+        import unittest
     unittest.main()