Add Service.job() helper method to get a Job by its sid.

Shakeel Mohamed · Shakeel Mohamed · commit 92bc3db7b706 · 2015-07-16T15:53:44.000-07:00
Also added tests &amp; an example.
diff --git a/examples/get_job.py b/examples/get_job.py
@@ -0,0 +1,51 @@
+#!/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 simple example showing to use the Service.job method to retrieve
+a search Job by its sid.
+"""
+
+import sys
+import os
+import time
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+import splunklib.client as client
+
+try:
+    from utils import *
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
+
+def main(argv):
+    opts = parse(argv, {}, ".splunkrc")
+    service = client.connect(**opts.kwargs)
+
+    # Execute a simple search, and store the sid
+    sid = service.search("search index=_internal | head 5").sid
+
+    # Now, we can get the `Job`
+    job = service.job(sid)
+
+    # Wait for the job to complete
+    while not job.is_done():
+        time.sleep(1)
+
+    print "Number of events found: %d" % int(job["eventCount"])
+
+if __name__ == "__main__":
+    main(sys.argv[1:])
+
diff --git a/splunklib/client.py b/splunklib/client.py
@@ -457,6 +457,13 @@ def inputs(self):
         """
         return Inputs(self)
 
+    def job(self, sid):
+        """Retrieves a search job by sid.
+
+        :return: A :class:`Job` object.
+        """
+        return Job(self, sid).refresh()
+
     @property
     def jobs(self):
         """Returns the collection of current search jobs.
diff --git a/tests/test_job.py b/tests/test_job.py
@@ -180,6 +180,18 @@ def test_read_jobs(self):
             job.refresh()
             self.check_job(job)
 
+    def test_get_job(self):
+        sid = self.service.search("search index=_internal | head 10").sid
+        self.assertTrue(len(sid) > 0)
+
+        job = self.service.job(sid)
+        self.assertIsNotNone(job)
+
+        while not job.is_done():
+            sleep(1)
+
+        self.assertEqual(10, int(job["eventCount"]))
+        self.assertEqual(10, int(job["resultCount"]))
 
 class TestJobWithDelayedDone(testlib.SDKTestCase):
     def setUp(self):
