Renamed clearRestartMessage and installAppFromCollection with underscores.

Add fake_splunk_version context manager.

Author: Frederick Ross

tests/test_app.py

@@ -50,7 +50,7 @@ def tearDown(self):
             if app_name.startswith('delete-me'):
                 self.service.apps.delete(app_name)
                 self.assertEventuallyTrue(lambda: app_name not in self.service.apps)
-        self.clearRestartMessage()
+        self.clear_restart_message()
 
     def test_app_integrity(self):
         self.check_entity(self.app)
@@ -86,7 +86,7 @@ def test_delete(self):
         self.assertTrue(name in self.service.apps)
         self.service.apps.delete(name)
         self.assertFalse(name in self.service.apps)
-        self.clearRestartMessage() # We don't actually have to restart here.
+        self.clear_restart_message() # We don't actually have to restart here.
 
     def test_package(self):
         p = self.app.package()

tests/test_index.py

@@ -108,7 +108,7 @@ def test_submit_via_attached_socket(self):
         self.assertEventuallyTrue(lambda: self.totalEventCount() == eventCount+1, timeout=60)
 
     def test_upload(self):
-        self.installAppFromCollection("file_to_upload")
+        self.install_app_from_collection("file_to_upload")
 
         eventCount = int(self.index['totalEventCount'])
 

tests/test_input.py

@@ -59,7 +59,7 @@ def test_inputs_list_on_one_kind_with_search(self):
         self.assertEqual(expected, found)
 
     def test_oneshot(self):
-        self.installAppFromCollection('file_to_upload')
+        self.install_app_from_collection('file_to_upload')
 
         index_name = testlib.tmpname()
         index = self.service.indexes.create(index_name)
@@ -124,7 +124,7 @@ def test_lists_modular_inputs(self):
         else:
             # Install modular inputs to list, and restart
             # so they'll show up.
-            self.installAppFromCollection("modular-inputs")
+            self.install_app_from_collection("modular-inputs")
             self.uncheckedRestartSplunk()
 
             inputs = self.service.inputs

tests/test_job.py

@@ -114,7 +114,7 @@ def test_read_jobs(self):
 class TestJobWithDelayedDone(testlib.SDKTestCase):
     def setUp(self):
         super(TestJobWithDelayedDone, self).setUp()
-        self.installAppFromCollection("sleep_command")
+        self.install_app_from_collection("sleep_command")
         self.query = "search index=_internal | sleep done=100"
         self.job = self.service.jobs.create(
             query=self.query,

tests/test_modular_input_kinds.py

@@ -20,7 +20,7 @@
 class ModularInputKindTestCase(testlib.SDKTestCase):
     def setUp(self):
         super(ModularInputKindTestCase, self).setUp()
-        self.installAppFromCollection("modular-inputs")
+        self.install_app_from_collection("modular-inputs")
         self.uncheckedRestartSplunk()
 
     def test_list_arguments(self):

tests/test_service.py

@@ -101,6 +101,10 @@ def test_splunk_version(self):
         for p in v:
             self.assertTrue(isinstance(p, int) and p >= 0)
 
+        for version in [(4,3,3), (5,), (5,0,1)]:
+            with self.fake_splunk_version(version):
+                self.assertEqual(version, self.service.splunk_version)
+
 class TestSettings(testlib.SDKTestCase):
     def test_read_settings(self):
         settings = self.service.settings

tests/testlib.py

@@ -15,6 +15,7 @@
 # under the License.
 
 """Shared unit test utilities."""
+import contextlib
 
 import sys
 # Run the test suite on the SDK without installing it.
@@ -125,7 +126,7 @@ def check_entity(self, entity):
                         continue
                 raise
 
-    def clearRestartMessage(self):
+    def clear_restart_message(self):
         """Tell Splunk to forget that it needs to be restarted.
 
         This is used mostly in cases such as deleting a temporary application.
@@ -142,7 +143,17 @@ def clearRestartMessage(self):
             else:
                 raise
 
-    def installAppFromCollection(self, name):
+    @contextlib.contextmanager
+    def fake_splunk_version(self, version):
+        original_version = self.service.splunk_version
+        try:
+            self.service._splunk_version = version
+            yield
+        finally:
+            self.service._splunk_version = original_version
+
+
+    def install_app_from_collection(self, name):
         collectionName = 'sdk-app-collection'
         if collectionName not in self.service.apps:
             raise ValueError("sdk-test-application not installed in splunkd")
@@ -159,7 +170,7 @@ def pathInApp(self, appName, pathComponents):
         """Return a path to *pathComponents* in *appName*.
 
         `pathInApp` is used to refer to files in applications installed with
-        `installAppFromCollection`. For example, the app `file_to_upload` in
+        `install_app_from_collection`. For example, the app `file_to_upload` in
         the collection contains `log.txt`. To get the path to it, call::
 
             pathInApp('file_to_upload', ['log.txt'])
@@ -228,4 +239,4 @@ def tearDown(self):
                 self.service.apps.delete(appName)
                 wait(lambda: appName not in self.service.apps)
         if self.service.restart_required:
-            self.clearRestartMessage()
+            self.clear_restart_message()