Use skipTest instead of returns, add some TODOs for myself etc.

Author: Ickerday

splunklib/results.py

@@ -309,7 +309,8 @@ def __init__(self, stream):
         # JSON documents, each containing a result, as opposed to one
         # results element containing lots of results.
         stream = BufferedReader(stream)
-        self.is_preview = None
+        # Removed in Splunk 10
+        self.is_preview = False
         self._gen = self._parse_results(stream)
 
     def __iter__(self):

tests/searchcommands/test_csc_apps.py

@@ -22,15 +22,14 @@
 from tests import testlib
 
 
+# FIXME: Flaky. Splunk sometimes crashes, thus tests fail with timeouts,
+#        reset/refused connection errors etc. Doesn't seem to be our fault.
 @pytest.mark.smoke
 class TestCSC(testlib.SDKTestCase):
-    # FIXME: Flaky - Splunk sometimes crashes, thus the test fails.
-    #        Not sure whose fault it is yet.
     def test_eventing_app(self):
         app_name = "eventing_app"
-
         self.assertTrue(
-            app_name in self.service.apps, msg="%s is not installed." % app_name
+            app_name in self.service.apps, msg=f"{app_name} is not installed."
         )
 
         # Fetch the app
@@ -67,27 +66,26 @@ def test_eventing_app(self):
         self.assertEqual(state.title, "eventing_app")
 
         jobs = self.service.jobs
+        # TODO: Add debug logging for query waiting time
         stream = jobs.oneshot(
             'search index="_internal" | head 4000 | eventingcsc status=200 | head 10',
             output_mode="json",
         )
         result = results.JSONResultsReader(stream)
-        ds = list(result)
+        msgs = list(result)
 
+        # TODO: Why is this assert here?
         if self.service.splunk_version < (10,):
             self.assertEqual(result.is_preview, False)
 
-        self.assertTrue(isinstance(ds[0], (dict, results.Message)))
-        nonmessages = [d for d in ds if isinstance(d, dict)]
+        self.assertTrue(isinstance(msgs[0], (dict, results.Message)))
+        nonmessages = [msg for msg in msgs if isinstance(msg, dict)]
         self.assertTrue(len(nonmessages) <= 10)
 
-    # FIXME: Flaky - Splunk sometimes crashes, thus the test fails.
-    #        Not sure whose fault it is yet.
     def test_generating_app(self):
         app_name = "generating_app"
-
         self.assertTrue(
-            app_name in self.service.apps, msg="%s is not installed." % app_name
+            app_name in self.service.apps, msg=f"{app_name} is not installed."
         )
 
         # Fetch the app
@@ -133,9 +131,8 @@ def test_generating_app(self):
 
     def test_reporting_app(self):
         app_name = "reporting_app"
-
         self.assertTrue(
-            app_name in self.service.apps, msg="%s is not installed." % app_name
+            app_name in self.service.apps, msg=f"{app_name} is not installed."
         )
 
         # Fetch the app

tests/test_job.py

@@ -59,6 +59,7 @@ def test_oneshot(self):
         ds = list(result)
 
         if self.service.splunk_version < (10,):
+            # TODO: Why is this assert here?
             self.assertEqual(result.is_preview, False)
 
         self.assertTrue(isinstance(ds[0], dict) or isinstance(ds[0], results.Message))
@@ -78,6 +79,7 @@ def test_export(self):
         ds = list(result)
 
         if self.service.splunk_version < (10,):
+            # TODO: Why is this assert here?
             self.assertEqual(result.is_preview, False)
 
         self.assertTrue(isinstance(ds[0], dict) or isinstance(ds[0], results.Message))
@@ -101,6 +103,7 @@ def test_export_docstring_sample(self):
                 pass  # print(result)
 
         if self.service.splunk_version < (10,):
+            # TODO: Why is this assert here?
             self.assertFalse(rr.is_preview)
 
     def test_results_docstring_sample(self):
@@ -120,11 +123,11 @@ def test_results_docstring_sample(self):
                 pass  # print(result)
 
         if self.service.splunk_version < (10,):
+            # TODO: Why is this assert here?
             self.assertFalse(rr.is_preview)
 
     def test_preview_docstring_sample(self):
-        from splunklib import client
-        from splunklib import results
+        from splunklib import client, results
 
         service = self.service  # cheat
         job = service.jobs.create("search * | head 5")
@@ -137,12 +140,6 @@ def test_preview_docstring_sample(self):
                 # Normal events are returned as dicts
                 pass  # print(result)
 
-        if self.service.splunk_version < (10,):
-            if rr.is_preview:
-                pass  # print("Preview of a running search job.")
-            else:
-                pass  # print("Job is finished. Results are final.")
-
     def test_oneshot_docstring_sample(self):
         from splunklib import results
 
@@ -159,6 +156,7 @@ def test_oneshot_docstring_sample(self):
                 pass  # print(result)
 
         if self.service.splunk_version < (10,):
+            # TODO: Why is this assert here?
             self.assertFalse(rr.is_preview)
 
     def test_normal_job_with_garbage_fails(self):

tests/test_modular_input_kinds.py

@@ -15,7 +15,7 @@
 # under the License.
 
 import pytest
-
+import unittest
 from tests import testlib
 
 from splunklib import client
@@ -31,8 +31,7 @@ def test_list_arguments(self):
         self.install_app_from_collection("modular_inputs")
 
         if self.service.splunk_version[0] < 5:
-            # Not implemented before 5.0
-            return
+            self.skipTest("Not implemented before 5.0")
 
         test1 = self.service.modular_input_kinds["test1"]
 
@@ -59,8 +58,7 @@ def test_update_raises_exception(self):
         self.install_app_from_collection("modular_inputs")
 
         if self.service.splunk_version[0] < 5:
-            # Not implemented before 5.0
-            return
+            self.skipTest("Not implemented before 5.0")
 
         test1 = self.service.modular_input_kinds["test1"]
         self.assertRaises(client.IllegalOperationException, test1.update, a="b")
@@ -78,8 +76,7 @@ def test_list_modular_inputs(self):
         self.install_app_from_collection("modular_inputs")
 
         if self.service.splunk_version[0] < 5:
-            # Not implemented before 5.0
-            return
+            self.skipTest("Not implemented before 5.0")
 
         for m in self.service.modular_input_kinds:
             self.check_modular_input_kind(m)