Merge pull request #51 from splunk/fross/test-suite-on-ace

All tests now pace with 4.3.3 and Ace.

Author: Fred Ross

splunklib/client.py

@@ -401,7 +401,7 @@ def messages(self):
     @property
     def modular_input_kinds(self):
         """Returns a collection of the modular input kinds on this Splunk instance."""
-        if self.splunk_version[0] >= 5:
+        if self.splunk_version >= (5,):
             return ReadOnlyCollection(self, PATH_MODULAR_INPUTS, item=ModularInputKind)
         else:
             raise IllegalOperationException("Modular inputs are not supported before Splunk version 5.")
@@ -1481,7 +1481,7 @@ def default(self):
         return index['defaultDatabase']
 
     def delete(self, name):
-        if self.service.splunk_version[0] >= 5:
+        if self.service.splunk_version >= (5,):
             Collection.delete(self, name)
         else:
             raise IllegalOperationException("Deleting indexes via the REST API is "
@@ -1548,28 +1548,42 @@ def attached_socket(self, *args, **kwargs):
 
     def clean(self, timeout=60):
         """Deletes the contents of the index.
-        
+
+        `clean` blocks until the index is empty, since it needs to restore
+        values at the end.
+
         :param `timeout`: The time-out period for the operation, in seconds (the
                           default is 60).
         """
         self.refresh()
         tds = self['maxTotalDataSizeMB']
         ftp = self['frozenTimePeriodInSecs']
-        self.update(maxTotalDataSizeMB=1, frozenTimePeriodInSecs=1)
-        self.roll_hot_buckets()
-
-        # Wait until the event count goes to zero
-        count = 0
-        while self.content.totalEventCount != '0' and count < timeout:
-            sleep(1)
-            count += 1
-            self.refresh()
+        was_disabled_initially = self.disabled
+        try:
+            if (not was_disabled_initially and \
+                self.service.splunk_version < (5,)):
+                # Need to disable the index first on Splunk 4.x,
+                # but it doesn't work to disable it on 5.0.
+                self.disable()
+            self.update(maxTotalDataSizeMB=1, frozenTimePeriodInSecs=1)
+            self.roll_hot_buckets()
 
-        # Restore original values
-        self.update(maxTotalDataSizeMB=tds,
-                    frozenTimePeriodInSecs=ftp)
-        if self.content.totalEventCount != '0':
-            raise OperationError, "Operation timed out."
+            start = datetime.now()
+            diff = timedelta(seconds=timeout)
+            # Wait until event count goes to 0.
+            while self.content.totalEventCount != '0' and datetime.now() < start+diff:
+                sleep(1)
+                self.refresh()
+        finally:
+            # Restore original values
+            self.update(maxTotalDataSizeMB=tds, frozenTimePeriodInSecs=ftp)
+            if self.content.totalEventCount != '0':
+                raise OperationError, "Cleaning index %s took longer than %s seconds; timing out." % \
+                                      (self.name, timeout)
+            if (not was_disabled_initially and \
+                self.service.splunk_version < (5,)):
+                # Re-enable the index if it was originally enabled and we messed with it.
+                self.enable()
         return self
 
     def disable(self):

tests/test_app.py

@@ -20,7 +20,7 @@
 import splunklib.client as client
 import splunklib.data as data
 
-class TestApp(testlib.TestCase):
+class TestApp(testlib.SDKTestCase):
     app = None
     app_name = None
     def setUp(self):

tests/test_binding.py

@@ -400,7 +400,7 @@ def isatom(body):
         root.find(XNAME_ID) is not None and \
         root.find(XNAME_TITLE) is not None
 
-class TestPluggableHTTP(testlib.TestCase):
+class TestPluggableHTTP(testlib.SDKTestCase):
     # Verify pluggable HTTP reqeust handlers.
     def test_handlers(self):
         paths = ["/services", "authentication/users", 

tests/test_collection.py

@@ -37,9 +37,9 @@
 expected_fields_keys = set(['required', 'optional', 'wildcard'])
 
 
-class TestCase(testlib.TestCase):
+class CollectionTestCase(testlib.SDKTestCase):
     def setUp(self):
-        super(TestCase, self).setUp()
+        super(CollectionTestCase, self).setUp()
         if self.service.splunk_version[0] >= 5 and 'modular_input_kinds' not in collections:
             collections.append('modular_input_kinds') # Not supported before Splunk 5.0
         else:

tests/test_conf.py

@@ -19,7 +19,7 @@
 
 import splunklib.client as client
 
-class TestRead(testlib.TestCase):
+class TestRead(testlib.SDKTestCase):
     def test_read(self):
         service = client.connect(**self.opts.kwargs)
 
@@ -36,7 +36,7 @@ def test_read(self):
         for stanza in confs['indexes'].list(count=5):
             self.check_entity(stanza)
 
-class TestConfs(testlib.TestCase):
+class TestConfs(testlib.SDKTestCase):
     def setUp(self):
         super(TestConfs, self).setUp()
         self.app_name = testlib.tmpname()

tests/test_data.py

@@ -21,7 +21,7 @@
 
 import splunklib.data as data
 
-class TestCase(testlib.TestCase):
+class DataTestCase(testlib.SDKTestCase):
     def test_elems(self):
         result = data.load("")
         self.assertTrue(result is None)

tests/test_event_type.py

@@ -19,12 +19,12 @@
 
 import splunklib.client as client
 
-class TestRead(testlib.TestCase):
+class TestRead(testlib.SDKTestCase):
     def test_read(self):
         for event_type in self.service.event_types.list(count=1):
             self.check_entity(event_type)
 
-class TestCreate(testlib.TestCase):
+class TestCreate(testlib.SDKTestCase):
     def test_create(self):
         self.event_type_name = testlib.tmpname()
         event_types = self.service.event_types
@@ -47,7 +47,7 @@ def tearDown(self):
         except KeyError:
             pass
 
-class TestEventType(testlib.TestCase):
+class TestEventType(testlib.SDKTestCase):
     def setUp(self):
         super(TestEventType, self).setUp()
         self.event_type_name = testlib.tmpname()

tests/test_examples.py

@@ -51,13 +51,13 @@ def start(script, stdin=None, stdout=PIPE, stderr=None):
     return Popen(script, stdin=stdin, stdout=stdout, stderr=stderr, cwd='../examples')
 
 # Rudimentary sanity check for each of the examples
-class TestCase(testlib.TestCase):
+class ExamplesTestCase(testlib.SDKTestCase):
     def check_commands(self, *args):
         for arg in args: 
             self.assertEquals(run(arg), 0)
 
     def setUp(self):
-        testlib.TestCase.setUp(self)
+        super(ExamplesTestCase, self).setUp()
 
         # Ignore result, it might already exist
         run("index.py create sdk-tests")

tests/test_fired_alert.py

@@ -19,9 +19,9 @@
 
 import splunklib.client as client
 
-class TestCase(testlib.TestCase):
+class FiredAlertTestCase(testlib.SDKTestCase):
     def setUp(self):
-        super(TestCase, self).setUp()
+        super(FiredAlertTestCase, self).setUp()
         self.index_name = testlib.tmpname()
         self.assertFalse(self.index_name in self.service.indexes)
         self.index = self.service.indexes.create(self.index_name)
@@ -44,7 +44,7 @@ def setUp(self):
             query, **kwargs)
 
     def tearDown(self):
-        super(TestCase, self).tearDown()
+        super(FiredAlertTestCase, self).tearDown()
         for saved_search in self.service.saved_searches:
             if saved_search.name.startswith('delete-me'):
                 self.service.saved_searches.delete(saved_search.name)

tests/test_index.py

@@ -22,7 +22,7 @@
 
 import logging
 
-class IndexTest(testlib.TestCase):
+class IndexTest(testlib.SDKTestCase):
     def setUp(self):
         super(IndexTest, self).setUp()
         self.index_name = testlib.tmpname()
@@ -34,7 +34,7 @@ def tearDown(self):
         # 5.0. In 4.x, we just have to leave them lying around until
         # someone cares to go clean them up. Unique naming prevents
         # clashes, though.
-        if self.service.splunk_version[0] >= 5:
+        if self.service.splunk_version >= (5,):
             self.service.indexes.delete(self.index_name)
         else:
             logging.warning("test_index.py:TestDeleteIndex: Skipped: cannot "
@@ -57,6 +57,17 @@ def test_disable_enable(self):
         self.index.refresh()
         self.assertEqual(self.index['disabled'], '0')
 
+    def test_submit_and_clean(self):
+        self.index.refresh()
+
+        originalCount = int(self.index['totalEventCount'])
+        self.index.submit("Hello again!", sourcetype="Boris", host="meep")
+        testlib.retry(self.index, 'totalEventCount', str(originalCount+1), step=1)
+        self.assertEqual(self.index['totalEventCount'], str(originalCount+1))
+
+        self.index.clean(timeout=500)
+        self.assertEqual(self.index['totalEventCount'], '0')
+
 class IndexWithRestartTest(IndexTest):
     def setUp(self):
         super(IndexWithRestartTest, self).setUp()
@@ -67,7 +78,6 @@ def test_prefresh(self):
         index = self.service.indexes[self.index_name]
         self.assertEqual(self.index['disabled'], '0') # Index is prefreshed
 
-
     def test_submit(self):
         eventCount = int(self.index['totalEventCount'])
         self.assertEqual(self.index['sync'], '0')
@@ -76,19 +86,6 @@ def test_submit(self):
         testlib.retry(self.index, 'totalEventCount', str(eventCount+1), step=1)
         self.assertEqual(self.index['totalEventCount'], str(eventCount+1))
 
-    def test_submit_and_clean(self):
-        # This fails on Ace beta because the index cannot be cleaned or deleted when disabled.
-        self.index.refresh()
-        originalCount = int(self.index['totalEventCount'])
-        self.index.submit("Hello again!", sourcetype="Boris", host="meep")
-        testlib.retry(self.index, 'totalEventCount', str(originalCount+1), step=1)
-        self.assertEqual(self.index['totalEventCount'], str(originalCount+1))
-        self.index.disable()
-        self.index.clean()
-        testlib.retry(self.index, 'totalEventCount', '0', step=1, times=60)
-        self.index.refresh()
-        self.assertEqual(self.index['totalEventCount'], '0')
-
     def test_submit_via_attach(self):
         eventCount = int(self.index['totalEventCount'])
         cn = self.index.attach()