Resolves a number of test failures verified locally

TODO: Verify on EL6-4 OSX-8, OSX-9, and WS08-R2 test rigs

1. DVPL-3260: Make Job.isReady use the dispatchState field on HTTP status 200 to determine if it is indeed ready
2. test_disable_enable (test_index.IndexTest)
3. test_setpriority (test_job.TestJobWithDelayedDone)
4. test_enable_preview (test_job.TestJobWithDelayedDone)
5. test_index (test_examples.ExamplesTestCase)
6. test_list_with_sort_mode_auto (test_collection.CollectionTestCase+)
7. test_search (test_examples.ExamplesTestCase)
8. test_suppress (test_saved_search.TestSavedSearch)
9. test_update (test_app.TestApp)

Author: David Noble

examples/search.py

@@ -79,7 +79,8 @@ def main(argv):
 
     job = service.jobs.create(search, **kwargs_create)
     while True:
-        job.refresh()
+        while not job.is_ready():
+            pass
         stats = {'isDone': job['isDone'],
                  'doneProgress': job['doneProgress'],
                  'scanCount': job['scanCount'],

splunklib/client.py

@@ -527,8 +527,6 @@ def restart_required(self):
                 titles = [messages['entry']['title']]
             else:
                 titles = [x['title'] for x in messages['entry']]
-            for title in titles:
-                print title
             result = 'restart_required' in titles
         return result
 
@@ -981,7 +979,7 @@ def content(self):
     def disable(self):
         """Disables the entity at this endpoint."""
         self.post("disable")
-        if self.service._splunk_version[0] < 6:
+        if self.service.restart_required:
             self.restartSplunk()
         return self
 
@@ -2993,7 +2991,7 @@ def suppress(self, expiration):
 
         :return: The :class:`SavedSearch`.
         """
-        self.post("suppress", suppressed="1", expiration=expiration)
+        self.post("suppress", expiration=expiration)
         return self
 
     @property
@@ -3015,7 +3013,7 @@ def unsuppress(self):
 
         :return: The :class:`SavedSearch`.
         """
-        self.post("suppress", suppressed="0", expiration="0")
+        self.post("suppress", expiration="0")
         return self
 
 

splunklib/data.py

@@ -225,7 +225,7 @@ def fromkv(k, v):
     def __getitem__(self, key):
         if key in self:
             return dict.__getitem__(self, key)
-        key = key + self.sep
+        key += self.sep
         result = record()
         for k,v in self.iteritems():
             if not k.startswith(key):

tests/test_app.py

@@ -70,14 +70,14 @@ def test_update(self):
             'author': "Me",
             'description': "Test app description",
             'label': "SDK Test",
-            'manageable': False,
+            'version': "1.1",
             'visible': True,
         }
         self.app.update(**kwargs)
         self.app.refresh()
         self.assertEqual(self.app['author'], "Me")
         self.assertEqual(self.app['label'], "SDK Test")
-        self.assertEqual(self.app['manageable'], "0")
+        self.assertEqual(self.app['version'], "1.1")
         self.assertEqual(self.app['visible'], "1")
 
     def test_delete(self):

tests/test_collection.py

@@ -138,17 +138,28 @@ def test_list_with_sort_dir(self):
                                  (coll_name, expected, found))
 
     def test_list_with_sort_mode_auto(self):
+        # The jobs collection requires special handling. The sort_dir kwarg is
+        # needed because the default sorting direction for jobs is "desc", not
+        # "asc". The sort_key kwarg is required because there is no default
+        # sort_key for jobs in Splunk 6.
         for coll_name in collections:
             coll = getattr(self.service, coll_name)
-            # sort_dir is needed because the default sorting direction
-            # for jobs is "desc", not "asc", so we have to set it explicitly or our tests break.
-            expected = [ent.name for ent in coll.list(sort_mode="auto", sort_dir="asc")]
+            if coll_name == 'jobs':
+                expected = [ent.name for ent in coll.list(
+                    sort_mode="auto", sort_dir="asc", sort_key="sid")]
+            else:
+                expected = [ent.name for ent in coll.list(sort_mode="auto")]
+
             if len(expected) == 0:
                 logging.debug("No entities in collection %s; skipping test.", coll_name)
-            found = [ent.name for ent in coll.list(sort_dir="asc")]
-            self.assertEqual(expected, found,
-                             msg='on %s (expected: %s, found: %s)' % \
-                                 (coll_name, expected, found))
+
+            if coll_name == 'jobs':
+                found = [ent.name for ent in coll.list(
+                    sort_dir="asc", sort_key="sid")]
+            else:
+                found = [ent.name for ent in coll.list()]
+
+            self.assertEqual(expected, found, msg='on %s (expected: %s, found: %s)' % (coll_name, expected, found))
 
     def test_list_with_sort_mode_alpha_case(self):
         for coll_name in collections:

tests/test_examples.py

@@ -23,6 +23,7 @@
 
 import splunklib.client as client
 
+
 def check_multiline(testcase, first, second, message=None):
     """Assert that two multi-line strings are equal."""
     testcase.assertTrue(isinstance(first, basestring), 
@@ -35,12 +36,14 @@ def check_multiline(testcase, first, second, message=None):
     if first != second:
         testcase.fail("Multiline strings are not equal: %s" % message)
 
+
 # Run the given python script and return its exit code. 
 def run(script, stdin=None, stdout=PIPE, stderr=None):
     process = start(script, stdin, stdout, stderr)
     process.communicate()
     return process.wait()
 
+
 # Start the given python script and return the corresponding process object.
 # The script can be specified as either a string or arg vector. In either case
 # it will be prefixed to invoke python explicitly.
@@ -50,11 +53,13 @@ def start(script, stdin=None, stdout=PIPE, stderr=None):
     script = ["python"] + script
     return Popen(script, stdin=stdin, stdout=stdout, stderr=stderr, cwd='../examples')
 
+
 # Rudimentary sanity check for each of the examples
 class ExamplesTestCase(testlib.SDKTestCase):
     def check_commands(self, *args):
-        for arg in args: 
-            self.assertEquals(run(arg), 0)
+        for arg in args:
+            result = run(arg)
+            self.assertEquals(result, 0)
 
     def setUp(self):
         super(ExamplesTestCase, self).setUp()
@@ -155,7 +160,7 @@ def test_index(self):
             "index.py disable sdk-tests",
             "index.py enable sdk-tests",
             "index.py clean sdk-tests")
-        self.restartSplunk()
+        self.service.restart(120)
 
     def test_info(self):
         self.check_commands(

tests/test_job.py

@@ -194,29 +194,33 @@ def test_enable_preview(self):
             print "Test requires sdk-app-collection. Skipping."
             return
         self.install_app_from_collection("sleep_command")
-        self.query = "search index=_internal | sleep 100"
+        sleep_duration = 100
+        self.query = "search index=_internal | sleep %d" % sleep_duration
         self.job = self.service.jobs.create(
             query=self.query,
             earliest_time="-1m",
             priority=5,
             latest_time="now")
-        self.assertEqual(self.job['isPreviewEnabled'], '0')
+        while not self.job.is_ready():
+            pass
+        self.assertEqual(self.job.content['isPreviewEnabled'], '0')
         self.job.enable_preview()
 
-        def is_preview():
-            self.job.refresh()
-            if self.job.is_done():
+        def is_preview_enabled():
+            is_done = self.job.is_done()
+            if is_done:
                 self.fail('Job finished before preview enabled.')
-            return self.job['isPreviewEnabled'] == '1'
+            return self.job.content['isPreviewEnabled'] == '1'
 
-        self.assertEventuallyTrue(is_preview)
+        self.assertEventuallyTrue(is_preview_enabled)
+        return
 
     def test_setpriority(self):
         if not self.app_collection_installed():
             print "Test requires sdk-app-collection. Skipping."
             return
-        sleep_duration = 10
         self.install_app_from_collection("sleep_command")
+        sleep_duration = 100
         self.query = "search index=_internal | sleep %s" % sleep_duration
         self.job = self.service.jobs.create(
             query=self.query,
@@ -238,10 +242,10 @@ def test_setpriority(self):
         def f():
             if self.job.is_done():
                 self.fail("Job already done before priority was set.")
-            print self.job.content['dispatchState']
             return int(self.job.content['priority']) == new_priority
 
         self.assertEventuallyTrue(f, timeout=sleep_duration + 5)
+        return
 
 
 class TestJob(testlib.SDKTestCase):

tests/test_saved_search.py

@@ -190,7 +190,7 @@ def test_suppress(self):
         self.assertGreaterEqual(suppressed_time, 0)
         new_suppressed_time = suppressed_time+100
         self.saved_search.suppress(new_suppressed_time)
-        self.assertLessEqual(self.saved_search['suppressed'], 
+        self.assertLessEqual(self.saved_search['suppressed'],
                              new_suppressed_time)
         self.assertGreater(self.saved_search['suppressed'],
                            suppressed_time)

tests/testlib.py

@@ -172,6 +172,8 @@ def install_app_from_collection(self, name):
         except client.HTTPError as he:
             if he.status == 400:
                 raise IOError("App %s not found in app collection" % name)
+        if self.service.restart_required:
+            self.service.restart(120)
         self.installedApps.append(name)
 
     def app_collection_installed(self):