Got most things running with Ace.

Everything left appears to be an issue in the Ace beta, not the SDK.

Author: Frederick Ross

splunklib/binding.py

@@ -696,7 +696,7 @@ def _abspath(self, path_segment,
             c._abspath('/a/b c/d') == '/a/b%20c/d'
             c._abspath('apps/local/search') == \
                 '/servicesNS/boris/search/apps/local/search'
-            c._abspath('apps/local/search', sharing='systmem') == \
+            c._abspath('apps/local/search', sharing='system') == \
                 '/servicesNS/nobody/system/apps/local/search'
             url = c.authority + c._abspath('apps/local/sharing')
         """
@@ -722,8 +722,9 @@ def _abspath(self, path_segment,
 
         oname = "-" if ns.owner is None else ns.owner
         aname = "-" if ns.app is None else ns.app
-        return UrlEncoded("/servicesNS/%s/%s/%s" % (oname, aname, path_segment),
+        path = UrlEncoded("/servicesNS/%s/%s/%s" % (oname, aname, path_segment),
                           skip_encode=skip_encode)
+        return path
 
 def connect(**kwargs):
     """Return an authenticated ``Context`` object.

splunklib/client.py

@@ -110,6 +110,15 @@
 class IncomparableException(Exception):
     pass
 
+def trailing(template, *targets):
+    s = template
+    for t in targets:
+        n = s.find(t)
+        if n == -1:
+            raise ValueError("Target " + t + " not found in template.")
+        s = s[n + len(t):]
+    return s
+
 # Filter the given state content record according to the given arg list.
 def _filter_content(content, *args):
     if len(args) > 0:
@@ -458,7 +467,8 @@ def get(self, path_segment="", owner=None, app=None, sharing=None, **query):
         if path_segment.startswith('/'):
             path = path_segment
         else:
-            path = self.path + path_segment
+            path = self.service._abspath(self.path + path_segment, owner=owner, 
+                                         app=app, sharing=sharing)
         # ^-- This was "%s%s" % (self.path, path_segment). 
         # That doesn't work, because self.path may be UrlEncoded.
         return self.service.get(path, 
@@ -513,7 +523,8 @@ def post(self, path_segment="", owner=None, app=None, sharing=None, **query):
         if path_segment.startswith('/'):
             path = path_segment
         else:
-            path = self.path + path_segment
+            path = self.service._abspath(self.path + path_segment, owner=owner, 
+                                         app=app, sharing=sharing)
         return self.service.post(path, 
                                  owner=owner, app=app, sharing=sharing,
                                  **query)
@@ -986,7 +997,13 @@ def _entity_path(self, state):
         # This has been factored out so that it can be easily
         # overloaded by Configurations, which has to switch its
         # entities' endpoints from its own properties/ to configs/.
-        return urllib.unquote(state.links.alternate)
+        raw_path = urllib.unquote(state.links.alternate)
+        if 'servicesNS/' in raw_path:
+            return trailing(raw_path, 'servicesNS/', '/', '/')
+        elif 'services/' in raw_path:
+            return trailing(raw_path, 'services/')
+        else:
+            return raw_path
 
     def _load_list(self, response):
         """Converts *response* to a list of entities.
@@ -1080,7 +1097,7 @@ def create(self, name, **params):
             state = _parse_atom_entry(entry)
             entity = self.item(
                 self.service,
-                urllib.unquote(state.links.alternate),
+                self._entity_path(state),
                 state=state)
             return entity
 
@@ -1278,7 +1295,7 @@ def _entity_path(self, state):
         # Overridden to make all the ConfigurationFile objects
         # returned refer to the configs/ path instead of the
         # properties/ path used by Configrations.
-        return self.service._abspath(PATH_CONF % state['title'])
+        return PATH_CONF % state['title']
 
 
 class Stanza(Entity):
@@ -1363,6 +1380,20 @@ def clean(self, timeout=60):
             raise OperationError, "Operation timed out."
         return self
 
+    def disable(self):
+        """Disables this index."""
+        # Starting in Ace, we have to do this with specific sharing,
+        # unlike most other entities.
+        self.post("disable", sharing="system")
+        return self
+
+    def enable(self):
+        """Enables this index."""
+        # Starting in Ace, we have to reenable this with a specific
+        # sharing unlike most other entities.
+        self.post("enable", sharing="system")
+        return self
+
     def roll_hot_buckets(self):
         """Performs rolling hot buckets for this index."""
         self.post("roll-hot-buckets")
@@ -1819,7 +1850,7 @@ def export(self, query, **params):
         to two for create followed by preview), plus at most two more
         if autologin is turned on.
 
-        :raises SyntaxError: on invalid queries.
+        :raises ValueError: on invalid queries.
 
         :param query: Splunk search language query to run
         :type query: ``str``
@@ -1831,8 +1862,8 @@ def export(self, query, **params):
         try:
             return self.post(path_segment="export", search=query, **params).body
         except HTTPError as he:
-            if he.status == 400 and 'Search operation' in str(he):
-                raise SyntaxError(str(he))
+            if he.status == 400:
+                raise ValueError(str(he))
             else:
                 raise
 
@@ -1858,7 +1889,7 @@ def oneshot(self, query, **params):
         to two for create followed by results), plus at most two more
         if autologin is turned on.
 
-        :raises SyntaxError: on invalid queries.
+        :raises ValueError: on invalid queries.
 
         :param query: Splunk search language query to run
         :type query: ``str``
@@ -1870,8 +1901,8 @@ def oneshot(self, query, **params):
         try:
             return self.post(search=query, exec_mode="oneshot", **params).body
         except HTTPError as he:
-            if he.status == 400 and 'Search operation' in str(he):
-                raise SyntaxError(str(he))
+            if he.status == 400:
+                raise ValueError(str(he))
             else:
                 raise
 

tests/test_app.py

@@ -28,11 +28,19 @@ def check_app(self, app):
     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)
 

tests/test_collection.py

@@ -77,7 +77,7 @@ def check_iterable(self, collection, count):
         seen = 0
         for item in collection: 
             seen += 1
-            print item.name
+            item.name
         self.assertEqual(seen, count)
 
     def test_apps(self):

tests/test_event_type.py

@@ -56,14 +56,15 @@ def test_crud(self):
         kwargs['priority'] = 3
         event_type.update(**kwargs)
         event_type.refresh()
+        testlib.restart(service)
         self.check_content(event_type, **kwargs)
 
         event_type.enable()
         event_type.refresh()
         self.check_content(event_type, disabled=0)
 
         event_types.delete('sdk-test')
-        self.assertFalse('sdk-teset' in event_types)
+        self.assertFalse('sdk-test' in event_types)
 
 if __name__ == "__main__":
     testlib.main()

tests/test_fired_alert.py

@@ -86,7 +86,9 @@ def test_crud(self):
 
         # Wait for the saved search to run. When it runs we will see a new job
         # show up in the search's history.
-        testlib.wait(search, lambda search: len(search.history()) == 1)
+        def f(search):
+            return len(search.history()) == 1
+        testlib.wait(search, f)
         self.assertEqual(len(search.history()), 1)
 
         # When it first runs the alert count should be zero.

tests/test_index.py

@@ -57,11 +57,13 @@ def test_read(self):
 
     def test_disable(self):
         self.index.disable()
+        testlib.restart(self.service)
         self.index.refresh()
         self.assertEqual(self.index['disabled'], '1')
 
     def test_enable(self):
         self.index.enable()
+        testlib.restart(self.service)
         self.index.refresh()
         self.assertEqual(self.index['disabled'], '0')
 
@@ -76,8 +78,11 @@ def test_attach(self):
         cn = self.index.attach()
         cn.send("Hello Boris!\r\n")
         cn.close()
-        print count
-        self.assertEventuallyEqual(lambda: self.index.refresh() and int(self.index['totalEventCount']), count+1)
+        def f():
+            self.index.refresh()
+            n = int(self.index['totalEventCount'])
+            return n
+        self.assertEventuallyEqual(f, count+1)
 
     def test_submit(self):
         self.index.refresh()

tests/test_job.py

@@ -94,13 +94,12 @@ def test_crud(self):
         result = results.ResultsReader(jobs.export("search index=_internal earliest=-1m | head 3"))
         self.assertEqual(result.is_preview, False)
         d = result.next()
-        print d
         self.assertTrue(isinstance(d, dict) or isinstance(d, results.Message))
         self.assertTrue(len(list(d for d in result if isinstance(d, dict))) <= 3)
 
-        self.assertRaises(SyntaxError, jobs.oneshot, "asdaf;lkj2r23=")
+        self.assertRaises(ValueError, jobs.oneshot, "asdaf;lkj2r23=")
 
-        self.assertRaises(SyntaxError, jobs.export, "asdaf;lkj2r23=")
+        self.assertRaises(ValueError, jobs.export, "asdaf;lkj2r23=")
 
         # Make sure we can create a job
         job = jobs.create("search index=sdk-tests earliest=-1m | head 1")
@@ -164,7 +163,9 @@ def test_results(self):
         index = service.indexes['_internal']
         self.assertTrue(index['totalEventCount'] > 0)
 
-        job = jobs.create("search index=_internal | head 1000 | stats count")
+        job = jobs.create("search index=_internal | head 100 | stats count")
+        job.refresh()
+        self.assertEqual(job['isDone'], '0')
         self.assertRaises(ValueError, job.results)
         reader = results.ResultsReader(job.results(timeout=60))
         job.refresh()
@@ -177,14 +178,14 @@ def test_results(self):
         self.assertLessEqual(int(result["count"]), 1000)
 
         # Repeat the same thing, but without the .is_preview reference.
-        job = jobs.create("search index=_internal | head 1000 | stats count")
+        job = jobs.create("search index=_internal | head 100 | stats count")
         self.assertRaises(ValueError, job.results)
         reader = results.ResultsReader(job.results(timeout=60))
         job.refresh()
         self.assertEqual(job['isDone'], '1')
         result = reader.next()
         self.assertTrue(isinstance(result, dict))
-        self.assertLessEqual(int(result["count"]), 1000)
+        self.assertLessEqual(int(result["count"]), 30)
 
     def test_results_reader(self):
         # Run jobs.export("search index=_internal | stats count",

tests/test_service.py

@@ -125,6 +125,15 @@ def test_namespaces(self):
         self.assertFalse(service.apps.contains(appname))
         self.assertFalse(service.users.contains(username))
 
+    def test_trailing(self):
+        self.assertRaises(ValueError, client.trailing, 'this is a test', 'boris')
+        self.assertRaises(ValueError, client.trailing, 'this is a test', 's is', 'boris')
+        template = '/servicesNS/boris/search/another/path/segment/that runs on'
+        self.assertEqual(template, client.trailing(template))
+        self.assertEqual('boris/search/another/path/segment/that runs on', client.trailing(template, 'ervicesNS/'))
+        self.assertEqual('another/path/segment/that runs on', client.trailing(template, 'servicesNS/', '/', '/'))
+
+
     def test_parse(self):
         service = client.connect(**self.opts.kwargs)