Merge pull request #53 from splunk/fross/fired-alert-tests

Additional test fixes in Python.

Author: Fred Ross

README.md

@@ -86,7 +86,7 @@ built on Splunk and should not be used if you are concerned about the security
 of the credentails used in your development environment.
 
 You can view a sample `.splunkrc` file by looking at the `splunkrc.spec` file
-in the root directory of the repistory.
+in the root directory of the repository.
 
 ## Overview
 

setup.py

@@ -14,15 +14,63 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from distutils.core import setup
-
+from distutils.core import setup, Command
+import os, shutil
 import splunklib
 
+def run_test_suite():
+    import unittest
+    original_cwd = os.path.abspath(os.getcwd())
+    os.chdir('tests')
+    suite = unittest.defaultTestLoader.discover('.')
+    unittest.TextTestRunner().run(suite)
+    os.chdir(original_cwd)
+
+class CoverageCommand(Command):
+    """setup.py command to run code coverage of the test suite."""
+    description = "Create an HTML coverage report from running the full test suite."
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            import coverage
+        except ImportError:
+            print "Could not import coverage. Please install it and try again."
+            exit(1)
+        cov = coverage.coverage(source=['splunklib'])
+        cov.start()
+        run_test_suite()
+        cov.stop()
+        cov.html_report(directory='coverage_report')
+
+class TestCommand(Command):
+    """setup.py command to run the whole test suite."""
+    description = "Run test full test suite."
+    user_options = []
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        run_test_suite()
+
 setup(
     author="Splunk, Inc.",
 
     author_email="[email protected]",
 
+    cmdclass={'coverage': CoverageCommand,
+              'test': TestCommand},
+
     description="The Splunk Software Development Kit for Python.",
 
     license="http://www.apache.org/licenses/LICENSE-2.0",
@@ -47,3 +95,4 @@
     ],
 )
 
+

splunklib/client.py

@@ -446,6 +446,19 @@ def restart(self, timeout=None):
                 sleep(2)
         raise Exception, "Operation timed out."
 
+    @property
+    def restart_required(self):
+        """Is splunkd in a state that requires a restart?"""
+        response = self.get("messages").body.read()
+        messages = data.load(response)['feed']
+        if 'entry' not in messages:
+            titles = []
+        elif isinstance(messages['entry'], dict):
+            titles = [messages['entry']['title']]
+        else:
+            titles = [x['title'] for x in messages['entry']]
+        return 'restart_required' in titles
+
     @property
     def roles(self):
         """Returns a collection of user roles."""
@@ -2040,7 +2053,7 @@ def refresh(self, state=None):
                 raw_state = self._load_state(response)
                 raw_state['links'] = dict([(k, urllib.unquote(v)) for k,v in raw_state['links'].iteritems()])
                 self._state = raw_state
-                return self
+        return self
 
     def results(self, timeout=None, wait_time=1, **query_params):
         """Fetch search results as an InputStream IO handle.
@@ -2151,6 +2164,10 @@ def searchlog(self, **kwargs):
     def set_priority(self, value):
         """Sets this job's search priority in the range of 0-10.
 
+        Higher numbers indicate higher priority. Unless splunkd is
+        running as root, you can only decrease the priority of
+        a running job.
+
         :param `value`: The search priority.
         """
         self.post('control', action="setpriority", priority=value)

tests/README.md

@@ -4,7 +4,7 @@ The truth is that there really isn't a Splunk Test Framework. It simply uses
 Python's builtin unittest module.
 
 Each distinct area of the SDK is tested in a single file. For example,
-`splunk.client` is tested in `test_client.py`, while the examples are tested
+roles are tested in `test_role.py`, while the examples are tested
 in `test_examples.py`.
 
 Before running the test suite, make sure the instance of Splunk you
@@ -15,15 +15,19 @@ should at least disable the *NIX and Windows apps. Do not run the test
 suite against a production instance of Splunk! It will run just fine
 with the free Splunk license, so don't be stingy with instances.
 
-There are no dependencies to run the tests. You can simply execute:
+You also need to install the `sdk-app-collection` app in your instance of
+Splunk. The `sdk-app-collection` is a set of small, single purpose apps
+for testing capabilities that cannot be created with the REST API.You can
+fetch it from `https://github.com/splunk/sdk-app-collection`. Put the
+whole repository in `$SPLUNK_HOME/etc/apps`, so the git root would be
+`$SPLUNK_HOME/etc/apps/sdk-app-collection`.
 
-    cd tests
-    python -m unittest discover
+The test suite depends on nothing but Python's standard library. You can
+simply execute:
 
-or, if you have py.test installed,
+    python setup.py test
 
-    cd tests
-    py.test
+or run the test_all.py script in the tests/ directory.
 
 ## Code Coverage
 
@@ -33,32 +37,16 @@ at the author's website: http://nedbatchelder.com/code/coverage/
 
 To install it, simply use `easy_install` or `pip`:
 
-    easy_install coverage
+    pip install coverage
 
 or
 
-    pip install coverage
+    easy_install coverage
 
 Once you have `coverage.py` installed, you can run get coverage information
 as follows:
 
-    cd tests
-    coverage run runtests.py
-    coverage combine
-    coverage report
-
-If you are using py.test, youcan replace 
-
-    coverage run runtests.py 
-
-with 
-
-    coverage run `which py.test`
-
-which provides better reporting, and lets you specify any additional
-options, such as a particular file to test. Should you want to get an
-HTML report:
-
-    coverage html
+    python setup.py coverage
 
-and open `coverage_html_report/index.html` in your favorite browser.
+This will create an HTML report in coverage_html/. Open `coverage_html/index.html`
+in your favorite browser to see the coverage report.

tests/__init__.py

@@ -0,0 +1 @@
+pass