Added test case and example for Optional Retry

Author: ashah-splunk

examples/optional_retry.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2015 Splunk, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+"""A command line utility that shows how to use the optional retries parameters, "retries" defines the number of time
+an API call should be retried before erroring out and "retryBackoff" defines the time to wait in-between the API
+retry calls default value is 10 seconds.The example is shown using the "services" API to get list of the services
+after a splunk restart, API call will normally fail while Splunk in restart mode but with "retries" set it will
+prevent the error out """
+
+from __future__ import absolute_import
+from __future__ import print_function
+import sys, os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from splunklib.client import connect
+
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
+
+
+def main():
+    opts = parse([], {}, ".env")
+    kwargs = opts.kwargs.copy()
+    kwargs.update({'retries': 5, 'retryBackoff': 5})
+    service = connect(**kwargs)
+    service.restart(timeout=10)
+    print(service.get("/services"))
+
+
+if __name__ == "__main__":
+    main()

tests/test_service.py

@@ -177,10 +177,16 @@ def test_hec_event(self):
         response = event_collector_endpoint.post("", body=json.dumps(msg))
         self.assertEqual(response.status, 200)
 
+
+class TestOptionalRetry(unittest.TestCase):
+
     def test_optional_retry(self):
-        service = client.connect(retries=5, retryBackoff=5, **self.opts.kwargs)
-        service.restart(timeout=20)  # less timeout so the optional retry logic is executed
-        self.assertEqual(service.get("/services").status, 200)
+        opts = testlib.parse([], {}, ".env")
+        kwargs = opts.kwargs.copy()
+        kwargs.update({'retries': 5, 'retryBackoff': 5})
+        self.service = client.connect(**kwargs)
+        self.service.restart(timeout=10)  # timeout value kept lower than actual time needed for Splunk to restart
+        self.assertEqual(self.service.get("/services").status, 200)
 
 
 class TestCookieAuthentication(unittest.TestCase):

tests/testlib.py

@@ -21,13 +21,15 @@
 
 import sys
 from splunklib import six
+
 # Run the test suite on the SDK without installing it.
 sys.path.insert(0, '../')
 sys.path.insert(0, '../examples')
 
 import splunklib.client as client
 from time import sleep
 from datetime import datetime, timedelta
+
 try:
     import unittest2 as unittest
 except ImportError:
@@ -43,17 +45,21 @@
 import time
 
 import logging
+
 logging.basicConfig(
     filename='test.log',
     level=logging.DEBUG,
     format="%(asctime)s:%(levelname)s:%(message)s")
 
+
 class NoRestartRequiredError(Exception):
     pass
 
+
 class WaitTimedOutError(Exception):
     pass
 
+
 def to_bool(x):
     if x == '1':
         return True
@@ -64,7 +70,7 @@ def to_bool(x):
 
 
 def tmpname():
-    name = 'delete-me-' + str(os.getpid()) + str(time.time()).replace('.','-')
+    name = 'delete-me-' + str(os.getpid()) + str(time.time()).replace('.', '-')
     return name
 
 
@@ -77,7 +83,7 @@ def wait(predicate, timeout=60, pause_time=0.5):
             logging.debug("wait timed out after %d seconds", timeout)
             raise WaitTimedOutError
         sleep(pause_time)
-        logging.debug("wait finished after %s seconds", datetime.now()-start)
+        logging.debug("wait finished after %s seconds", datetime.now() - start)
 
 
 class SDKTestCase(unittest.TestCase):
@@ -94,7 +100,7 @@ def assertEventuallyTrue(self, predicate, timeout=30, pause_time=0.5,
                 logging.debug("wait timed out after %d seconds", timeout)
                 self.fail(timeout_message)
             sleep(pause_time)
-            logging.debug("wait finished after %s seconds", datetime.now()-start)
+            logging.debug("wait finished after %s seconds", datetime.now() - start)
 
     def check_content(self, entity, **kwargs):
         for k, v in six.iteritems(kwargs):
@@ -163,12 +169,11 @@ def fake_splunk_version(self, version):
         finally:
             self.service._splunk_version = original_version
 
-
     def install_app_from_collection(self, name):
         collectionName = 'sdkappcollection'
         if collectionName not in self.service.apps:
             raise ValueError("sdk-test-application not installed in splunkd")
-        appPath = self.pathInApp(collectionName, ["build", name+".tar"])
+        appPath = self.pathInApp(collectionName, ["build", name + ".tar"])
         kwargs = {"update": True, "name": appPath, "filename": True}
 
         try:
@@ -235,13 +240,13 @@ def setUpClass(cls):
         cls.opts = parse([], {}, ".env")
 
         # Before we start, make sure splunk doesn't need a restart.
-        service = client.connect(retries=5, retryBackoff=10, **cls.opts.kwargs)
+        service = client.connect(retries=5, **cls.opts.kwargs)
         if service.restart_required:
             service.restart(timeout=120)
 
     def setUp(self):
         unittest.TestCase.setUp(self)
-        self.service = client.connect(**self.opts.kwargs)
+        self.service = client.connect(retries=5, **self.opts.kwargs)
         # If Splunk is in a state requiring restart, go ahead
         # and restart. That way we'll be sane for the rest of
         # the test.