Added internal Jira ticket numbers to TODOs

Author: Shakeel Mohamed

setup.py

@@ -143,7 +143,7 @@ def run(self):
         sdk_dir = os.path.abspath('.')
 
         def exclude(path):
-            # TODO: Replace with filter function because exclude is deprecated
+            # TODO: DVPL-5866 - Replace with filter function because exclude is deprecated
             basename = os.path.basename(path)
             for pattern in ['.DS_Store', '.idea', '*.log', '*.py[co]']:
                 if fnmatch(basename, pattern):

splunklib/searchcommands/search_command.py

@@ -366,7 +366,7 @@ def records(reader):
             yield record
         return
 
-    # TODO: Is it possible to support anything other than write_error? It does not seem so.
+    # TODO: DVPL-5865 - Is it possible to support anything other than write_error? It does not seem so.
 
     def write_debug(self, message, *args):
         self._write_message(u'DEBUG', message, *args)

tests/searchcommands/test_decorators.py

@@ -107,7 +107,7 @@ def test_builtin_options(self):
 
             self.assertEqual(len(command.logger.handlers), 0)
 
-            # TODO: capture this output and verify it
+            # TODO: DVPL-5867 - capture this output and verify it
             command.logger.warning(
                 'Test that output is directed to stderr without formatting')
 

tests/searchcommands/test_examples.py

@@ -273,7 +273,7 @@ def test_option_show_configuration(self):
                 os.path.join('log', 'test_option_show_configuration.log')))
         return
 
-    # TODO, use a generating command that doesn't do random sampling because
+    # TODO: DVPL-5869 - use a generating command that doesn't do random sampling because
     # a seed is no guarantee that the same sample is produced on every platform
     # and all versions of python
 
@@ -421,7 +421,7 @@ def test_helloworld_generating_command_as_unit(self):
         return
 
     def test_generating_command_on_server(self):
-        # TODO: this test never has inconsistent results due to random sampling
+        # TODO: DVPL-5870 - this test has inconsistent results due to random sampling
         expected, actual = self._getOneshotResults(
             '| simulate csv=population.csv rate=200 interval=00:00:01 duration=00:00:02 seed=%s' % TestSearchCommandsApp._seed,
             'test_generating_command_on_server')
@@ -700,7 +700,7 @@ def _open_data_file(cls, relative_path, mode):
 
     @classmethod
     def _start_process(cls, args, stdin, stdout, stderr):
-        # TODO: make a shell script to run some of these seperately, check results there
+        # TODO: DVPL-5871 - make a shell script to run some of these separately, check results there
         return Popen(args, stdin=stdin, stdout=stdout, stderr=stderr,
                      cwd=cls.app_bin)
 

tests/test_collection.py

@@ -115,7 +115,7 @@ def test_list_with_search(self):
             expected = [ent.name for ent in coll.list()]
             if len(expected) == 0:
                 logging.debug("No entities in collection %s; skipping test.", coll_name)
-            # TODO: This should use a real search instead of *. Otherwise the test passes trivially.
+            # TODO: DVPL-5868 - This should use a real search instead of *. Otherwise the test passes trivially.
             found = [ent.name for ent in coll.list(search="*")]
             self.assertEqual(expected, found,
                              msg='on %s (expected: %s, found: %s)' % \