Checkpoint

Author: David Noble

setup.py

@@ -22,6 +22,7 @@
 import splunklib
 import tarfile
 
+
 def run_test_suite():
     try:
         import unittest2 as unittest
@@ -72,6 +73,7 @@ def finalize_options(self):
     def run(self):
         run_test_suite()
 
+
 class DistCommand(Command):
     """setup.py command to create .spl files for modular input and search
     command examples"""
@@ -98,8 +100,8 @@ def run(self):
         # Create random_numbers.spl and github_forks.spl
 
         app_names = ['random_numbers', 'github_forks']
-        splunklib_dir = "splunklib"
-        modinput_dir = os.path.join(splunklib_dir, "modularinput")
+        splunklib_arcname = "splunklib"
+        modinput_dir = os.path.join(splunklib_arcname, "modularinput")
 
         for app in app_names:
             with closing(tarfile.open(os.path.join("build", app + ".spl"), "w")) as spl:
@@ -117,11 +119,11 @@ def run(self):
                     arcname=os.path.join(app, "README", "inputs.conf.spec")
                 )
 
-                splunklib_files = self.get_python_files(os.listdir(splunklib_dir))
+                splunklib_files = self.get_python_files(os.listdir(splunklib_arcname))
                 for file_name in splunklib_files:
                     spl.add(
-                        os.path.join(splunklib_dir, file_name),
-                        arcname=os.path.join(app, "bin", splunklib_dir, file_name)
+                        os.path.join(splunklib_arcname, file_name),
+                        arcname=os.path.join(app, "bin", splunklib_arcname, file_name)
                     )
 
                 modinput_files = self.get_python_files(os.listdir(modinput_dir))
@@ -137,14 +139,6 @@ def run(self):
 
         sdk_dir = os.path.abspath('.')
 
-        tarball = os.path.join(sdk_dir, 'build', 'searchcommands_app.spl')
-
-        app_dir = os.path.join(sdk_dir, 'examples', 'searchcommands_app')
-        arc_app_dir = 'searchcommands_app'
-
-        lib_dir = os.path.join(sdk_dir, 'splunklib', 'searchcommands')
-        arc_app_lib_dir = os.path.join(arc_app_dir, 'bin', 'splunklib', 'searchcommands')
-
         def exclude(path):
             # TODO: Replace with filter function because exclude is deprecated
             basename = os.path.basename(path)
@@ -153,10 +147,25 @@ def exclude(path):
                     return True
             return False
 
-        with closing(tarfile.open(tarball, "w")) as spl:
-            spl.add(app_dir, arcname=arc_app_dir, exclude=exclude)
-            spl.add(lib_dir, arcname=arc_app_lib_dir, exclude=exclude)
+        tarball = os.path.join(sdk_dir, 'build', 'searchcommands_app.spl')
+
+        splunklib_arcname = os.path.join(
+            'searchcommands_app', 'bin', 'splunklib')
+
+        manifest = [
+            (os.path.join(sdk_dir, 'examples', 'searchcommands_app'),
+             'searchcommands_app'),
+            (os.path.join(sdk_dir, 'splunklib', '__init__.py'),
+             os.path.join(splunklib_arcname, '__init__.py')),
+            (os.path.join(sdk_dir, 'splunklib', 'searchcommands'),
+             os.path.join(splunklib_arcname, 'searchcommands'))
+        ]
+
+        with closing(tarfile.open(tarball, 'w')) as spl:
+            for source, target in manifest:
+                spl.add(source, arcname=target, exclude=exclude)
 
+        return
 
 setup(
     author="Splunk, Inc.",

tests/test_search_commands.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2013 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.
+
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+import testlib
+
+
+class SearchCommandsTestCase(testlib.SDKTestCase):
+    def setUp(self):
+        super(SearchCommandsTestCase, self).setUp()
+        self.uncheckedRestartSplunk()
+    
+    def test_lists_search_commands(self):
+        version_major = self.service.splunk_version[0]
+        if version_major < 5:
+            print(
+                'The splunklib.searchcommands module does not support Splunk '
+                '%d. Skipping.'
+                % version_major)
+            return
+        elif not self.app_collection_installed():
+            print('Test requires sdk-app-collection. Skipping.')
+            return
+        else:
+            # Install modular inputs to list, and restart so they'll show up
+            self.install_app_from_collection("modular-inputs")
+            self.uncheckedRestartSplunk()
+            inputs = self.service.inputs
+            if ('abcd','test2') not in inputs:
+                inputs.create('abcd', 'test2', field1='boris')
+
+            input = inputs['abcd', 'test2']
+            self.assertEqual(input.field1, 'boris')
+            for m in self.service.modular_input_kinds:
+                self.check_modular_input_kind(m)
+
+    def check_modular_input_kind(self, m):
+        print m.name
+        if m.name == 'test1':
+            self.assertEqual('Test "Input" - 1', m['title'])
+            self.assertEqual("xml", m['streaming_mode'])
+        elif m.name == 'test2':
+            self.assertEqual('test2', m['title'])
+            self.assertEqual('simple', m['streaming_mode'])
+
+
+if __name__ == "__main__":
+    unittest.main()