Merge pull request #44 from splunk/feature/testsuite

First round of Ace compatibility changes, and a completely revised test suite.

Author: Fred Ross

splunklib/binding.py

@@ -31,6 +31,8 @@
 import ssl
 import urllib
 import functools
+import logging
+from datetime import datetime
 
 from contextlib import contextmanager
 
@@ -53,6 +55,13 @@
 DEFAULT_PORT = "8089"
 DEFAULT_SCHEME = "https"
 
+@contextmanager
+def log_duration():
+    start_time = datetime.now()
+    yield
+    end_time = datetime.now()
+    logging.debug("Operation took %s", end_time-start_time)
+
 class AuthenticationError(Exception):
     pass
 
@@ -131,6 +140,8 @@ def __mod__(self, fields):
         ``TypeError``.
         """
         raise TypeError("Cannot interpolate into a UrlEncoded object.")
+    def __repr__(self):
+        return "UrlEncoded('%s')" % urllib.unquote(self)
 
 @contextmanager
 def _handle_auth_error(msg):
@@ -461,7 +472,10 @@ def delete(self, path_segment, owner=None, app=None, sharing=None, **query):
         """
         path = self.authority + self._abspath(path_segment, owner=owner,
                                               app=app, sharing=sharing)
-        return self.http.delete(path, self._auth_headers, **query)
+        logging.debug("DELETE request to %s (body: %s)", path, repr(query))
+        with log_duration():
+            response = self.http.delete(path, self._auth_headers, **query)
+        return response
 
     @_authentication
     def get(self, path_segment, owner=None, app=None, sharing=None, **query):
@@ -508,7 +522,10 @@ def get(self, path_segment, owner=None, app=None, sharing=None, **query):
         """
         path = self.authority + self._abspath(path_segment, owner=owner,
                                               app=app, sharing=sharing)
-        return self.http.get(path, self._auth_headers, **query)
+        logging.debug("GET request to %s (body: %s)", path, repr(query))
+        with log_duration():
+            response = self.http.get(path, self._auth_headers, **query)
+        return response
 
     @_authentication
     def post(self, path_segment, owner=None, app=None, sharing=None, **query):
@@ -558,7 +575,10 @@ def post(self, path_segment, owner=None, app=None, sharing=None, **query):
         """
         path = self.authority + self._abspath(path_segment, owner=owner, 
                                               app=app, sharing=sharing)
-        return self.http.post(path, self._auth_headers, **query)
+        logging.debug("POST request to %s (body: %s)", path, repr(query))
+        with log_duration():
+            response = self.http.post(path, self._auth_headers, **query)
+        return response
 
     @_authentication
     def request(self, path_segment, method="GET", headers=[], body="",
@@ -621,10 +641,14 @@ def request(self, path_segment, method="GET", headers=[], body="",
         # f's local namespace or g's, and cannot switch between them
         # during the run of the function.
         all_headers = headers + self._auth_headers
-        return self.http.request(path,
-                                 {'method': method,
-                                  'headers': all_headers,
-                                  'body': body})
+        logging.debug("%s request to %s (headers: %s, body: %s)", 
+                      method, path, str(all_headers), repr(body))
+        with log_duration():
+            response = self.http.request(path,
+                                         {'method': method,
+                                          'headers': all_headers,
+                                          'body': body})
+        return response
 
     def login(self):
         """Log into the Splunk instance referred to by this ``Context``.

splunklib/client.py

@@ -64,7 +64,7 @@
 import datetime
 import json
 import urllib
-
+import logging
 from time import sleep
 
 from binding import Context, HTTPError, AuthenticationError, namespace, UrlEncoded
@@ -107,6 +107,32 @@
 
 MATCH_ENTRY_CONTENT = "%s/%s/*" % (XNAME_ENTRY, XNAME_CONTENT)
 
+capabilities = record({k:k for k in [
+            "admin_all_objects", "change_authentication", 
+            "change_own_password", "delete_by_keyword",
+            "edit_deployment_client", "edit_deployment_server",
+            "edit_dist_peer", "edit_forwarders", "edit_httpauths",
+            "edit_input_defaults", "edit_monitor", "edit_roles",
+            "edit_scripted", "edit_search_server", "edit_server",
+            "edit_splunktcp", "edit_splunktcp_ssl", "edit_tcp",
+            "edit_udp", "edit_user", "edit_web_settings", "get_metadata",
+            "get_typeahead", "indexes_edit", "license_edit", "license_tab",
+            "list_deployment_client", "list_forwarders", "list_httpauths",
+            "list_inputs", "request_remote_tok", "rest_apps_management",
+            "rest_apps_view", "rest_properties_get", "rest_properties_set",
+            "restart_splunkd", "rtsearch", "schedule_search", "search",
+            "use_file_operator"]})
+
+
+class NoSuchUserException(Exception):
+    pass
+
+class NoSuchApplicationException(Exception):
+    pass
+
+class IllegalOperationException(Exception):
+    pass
+
 class IncomparableException(Exception):
     pass
 
@@ -116,6 +142,9 @@ class JobNotReadyException(Exception):
 class AmbiguousReferenceException(ValueError):
     pass
 
+class EntityDeletedException(Exception):
+    pass
+
 def trailing(template, *targets):
     """Substring of *template* following all *targets*.
 
@@ -1002,7 +1031,6 @@ def __len__(self):
             saved_searches = c.saved_searches
             n = len(saved_searches)
         """
-        m = self.list(count=1)
         return len(self.list())
 
     def _entity_path(self, state):
@@ -1225,6 +1253,7 @@ def iter(self, offset=0, count=None, pagesize=None, **kwargs):
                 # server.
                 ... 
         """
+        assert pagesize is None or pagesize > 0
         if count is None:
             count = self.null_count
         fetched = 0
@@ -1238,6 +1267,7 @@ def iter(self, offset=0, count=None, pagesize=None, **kwargs):
             if pagesize is None or N < pagesize:
                 break
             offset += N
+            logging.debug("pagesize=%d, fetched=%d, offset=%d, N=%d", pagesize, fetched, offset, N)
 
     # kwargs: count, offset, search, sort_dir, sort_key, sort_mode
     def list(self, count=None, **kwargs):
@@ -1930,6 +1960,9 @@ def export(self, query, **params):
             else:
                 raise
 
+    def itemmeta(self):
+        raise NotSupportedError()
+
 
     def oneshot(self, query, **params):
         """Run a search and directly return an InputStream IO handle over the results.

tests/test_app.py

@@ -15,89 +15,78 @@
 # under the License.
 
 import testlib
+import logging
 
 import splunklib.client as client
 import splunklib.data as data
 
-class TestCase(testlib.TestCase):
-    def check_app(self, app):
-        self.check_entity(app)
-        cfu = int(app.check_for_updates)
-        self.assertTrue(cfu == 1 or cfu == 0)
-
-    def test_read(self):
-        service = client.connect(**self.opts.kwargs)
-
-        disabled_app = 'sdk-test-app-disabled'
-        if (disabled_app in service.apps):
-            service.apps.delete(disabled_app)
-        disabled = service.apps.create(disabled_app)
-        disabled.disable()
-
-        for app in service.apps:
-            self.check_app(app)
-            app.refresh()
-            self.check_app(app)
-
-        service.apps.delete(disabled_app)
-
-    def test_crud(self):
-        service = client.connect(**self.opts.kwargs)
-
-        appname = "sdk-test-app"
-
-        testlib.delete_app(service, appname)
-        self.assertFalse(appname in service.apps)
-
+class TestApp(testlib.TestCase):
+    app = None
+    app_name = None
+    def setUp(self):
+        testlib.TestCase.setUp(self)
+        if self.app is None:
+            for app in self.service.apps:
+                if app.name.startswith('delete-me'):
+                    self.service.apps.delete(app.name)
+            # Creating apps takes 0.8s, which is too long to wait for
+            # each test in this test suite. Therefore we create one
+            # app and reuse it. Since apps are rather less fraught
+            # than entities like indexes, this is okay.
+            TestApp.app_name = testlib.tmpname()
+            TestApp.app = self.service.apps.create(self.app_name)
+            logging.debug("Creating app %s", self.app_name)
+        else:
+            logging.debug("App %s already exists. Skipping creation.", self.app_name)
+
+class TestAppIntegrity(TestApp):
+    def test_app_integrity(self):
+        self.check_entity(self.app)
+
+class TestDisableEnable(TestApp):
+    def test_disable_enable(self):
+        self.app.disable()
+        self.app.refresh()
+        self.assertEqual(self.app['disabled'], '1')
+        self.app.enable()
+        self.app.refresh()
+        self.assertEqual(self.app['disabled'], '0')
+
+class TestUpdate(TestApp):
+    def test_update(self):
         kwargs = {
             'author': "Me",
             'description': "Test app description",
             'label': "SDK Test",
             'manageable': False,
-            'template': "barebones",
             'visible': True,
         }
-        service.apps.create(appname, **kwargs)
-        self.assertTrue(appname in service.apps)
-        app = service.apps[appname]
-        self.assertTrue(isinstance(app.state.content, data.Record))
-        self.assertEqual(app['author'], "Me")
-        self.assertEqual(app['label'], "SDK Test")
-        self.assertEqual(app['manageable'], "0")
-        self.assertEqual(app['visible'], "1")
-
-        self.assertEqual(app.author, "Me")
-        self.assertEqual(app.label, "SDK Test")
-        self.assertEqual(app.manageable, "0")
-        self.assertEqual(app.visible, "1")
-
-        kwargs = {
-            'author': "SDK",
-            'visible': False,
-        }
-        app = service.apps[appname]
-        app.update(**kwargs)
-        app.refresh()
-        self.assertEqual(app['author'], "SDK")
-        self.assertEqual(app['label'], "SDK Test")
-        self.assertEqual(app['manageable'], "0")
-        self.assertEqual(app['visible'], "0")
-
-        testlib.delete_app(service, appname)
-        self.assertFalse(appname in service.apps)
-
+        self.app.update(**kwargs)
+        # self.app.refresh() <-- should be automatically refreshed
+        # after update.
+        self.assertEqual(self.app['author'], "Me")
+        self.assertEqual(self.app['label'], "SDK Test")
+        self.assertEqual(self.app['manageable'], "0")
+        self.assertEqual(self.app['visible'], "1")
+
+class TestDelete(TestApp):
+    def test_delete(self):
+        name = testlib.tmpname()
+        app = self.service.apps.create(name)
+        self.assertTrue(name in self.service.apps)
+        self.service.apps.delete(name)
+        self.assertFalse(name in self.service.apps)
+
+class TestPackage(TestApp):
     def test_package(self):
-        service = client.connect(**self.opts.kwargs)
-        app = service.apps['search']
-        p = app.package()
-        self.assertEqual(p.name, 'search')
-        self.assertTrue(p.path.endswith('search.spl'))
-        self.assertTrue(p.url.endswith('search.spl'))
+        p = self.app.package()
+        self.assertEqual(p.name, self.app_name)
+        self.assertTrue(p.path.endswith(self.app_name + '.spl'))
+        self.assertTrue(p.url.endswith(self.app_name + '.spl'))
 
+class TestUpdateInfo(TestApp):
     def test_updateInfo(self):
-        service = client.connect(**self.opts.kwargs)
-        app = service.apps['search']
-        p = app.updateInfo()
+        p = self.app.updateInfo()
         self.assertTrue(p is not None)
 
 if __name__ == "__main__":