Switched to server-side app collection. Fixed a couple restart issues in the index test suite. Added support for version key in .splunkrc (for compatibility with JavaScript).

Author: Frederick Ross

tests/test_index.py

@@ -42,8 +42,6 @@ def tearDown(self):
             logging.warning("test_index.py:TestDeleteIndex: Skipped: cannot "
                             "delete indexes via the REST API in Splunk 4.x")
 
-
-class IndexWithoutRestart(IndexTest):
     def totalEventCount(self):
         self.index.refresh()
         return int(self.index['totalEventCount'])
@@ -57,6 +55,7 @@ def test_default(self):
 
     def test_disable_enable(self):
         self.index.disable()
+        self.restartSplunk()
         self.index.refresh()
         self.assertEqual(self.index['disabled'], '1')
         self.index.enable()
@@ -65,10 +64,15 @@ def test_disable_enable(self):
 
     def test_submit_and_clean(self):
         self.index.refresh()
-
         originalCount = int(self.index['totalEventCount'])
         self.index.submit("Hello again!", sourcetype="Boris", host="meep")
         self.assertEventuallyEqual(originalCount+1, self.totalEventCount)
+
+        # Cleaning an enabled index on 4.x takes forever, so we disable it.
+        # However, cleaning it on 5 requires it to be enabled.
+        if self.service.splunk_version < (5,):
+            self.index.disable()
+            self.restartSplunk()
         self.index.clean(timeout=500)
         self.assertEqual(self.index['totalEventCount'], '0')
 

tests/testlib.py

@@ -143,22 +143,27 @@ def clearRestartMessage(self):
             else:
                 raise
 
-    def appCollectionPath(self):
-        if 'appcollection' not in self.opts.kwargs:
-            raise ValueError('No path to appcollection found in .splunkrc')
-        elif not os.path.isdir(self.opts.kwargs['appcollection']):
-            raise ValueError('appcollection not found at %s' % \
-                                self.opts.kwargs['appcollection'])
-        else:
-            return self.opts.kwargs['appcollection']
-
     def installAppFromCollection(self, name):
-        basePath = self.appCollectionPath()
-        appPath = os.path.abspath(os.path.join(basePath, "build", name + ".tar"))
-        if not os.path.isfile(appPath):
-            raise ValueError("No such application at %s" % appPath)
+        collectionName = 'sdk-app-collection'
+        if collectionName not in self.service.apps:
+            raise ValueError("sdk-test-application not installed in splunkd")
+        splunkHome = self.service.settings['SPLUNK_HOME']
+        if "/" in splunkHome and "\\" in splunkHome:
+            raise ValueError("There are both forward and back slashes in $SPLUNK_HOME. What system are you on?!?")
+        elif "/" in splunkHome:
+            separator = "/"
+        elif "\\" in splunkHome:
+            separator = "\\"
+        else:
+            raise ValueError("No separators in $SPLUNK_HOME. Can't determine what file separator to use.")
+        appPath = separator.join([splunkHome, "etc", "apps", collectionName,
+                                  "build", name + ".tar"])
         kwargs = {"update": 1, "name": appPath}
-        self.service.post("apps/appinstall", **kwargs)
+        try:
+            self.service.post("apps/appinstall", **kwargs)
+        except client.HTTPError as he:
+            if he.status == 400:
+                raise IOError("App %s not found in app collection" % name)
         self.installedApps.append(name)
 
     def restartSplunk(self, timeout=120):

utils/__init__.py

@@ -63,16 +63,10 @@ def config(option, opt, value, parser):
         'default': None,
         'help': "Password to login with" 
     },
-    # This is introduced for the Java SDK's test suite. It has
-    # to be here in order to share a single .splunkrc among the
-    # SDKs, but is not yet used in Python (though it will probably
-    # be used in future). It's optional, though, so we don't need
-    # to change the README or otherwise document it in the Python
-    # SDK for now.
-    'appcollection': {
-        'flags': ["--appcollection"],
+    'version': {
+        'flags': ["--version"],
         'default': None,
-        'help': "Path to appcollection"
+        'help': 'Ignore. Used by JavaScript SDK.'
     }
 }