Python 3.x compatibility for test_builtin_options

Author: amysutedja

examples/searchcommands_app/package/default/logging.conf

@@ -7,44 +7,64 @@
 keys = root, splunklib, CountMatchesCommand, GenerateHelloCommand, GenerateTextCommand, SimulateCommand, SumCommand
 
 [logger_root]
-level = WARNING       ; Default: WARNING
-handlers = stderr     ; Default: stderr
+; Default: WARNING
+level = WARNING
+; Default: stderr
+handlers = stderr
 
 [logger_splunklib]
 qualname = splunklib
-level = NOTSET        ; Default: WARNING
-handlers = splunklib  ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
 
 [logger_CountMatchesCommand]
 qualname = CountMatchesCommand
-level = NOTSET    ; Default: WARNING
-handlers = app    ; Default: stderr
-propagate = 0     ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; Default: 1
+propagate = 0
 
 [logger_GenerateHelloCommand]
 qualname = GenerateHelloCommand
-level = DEBUG     ; Default: WARNING
-handlers = app    ; Default: stderr
-propagate = 0     ; Default: 1
+; Default: WARNING
+level = DEBUG
+; Default: stderr
+handlers = app
+; Default: 1
+propagate = 0
 
 [logger_GenerateTextCommand]
 qualname = GenerateTextCommand
-level = DEBUG           ; Default: WARNING
-handlers = app          ; Default: stderr
-propagate = 0           ; Default: 1
+; Default: WARNING
+level = DEBUG
+; Default: stderr
+handlers = app
+; Default: 1
+propagate = 0
 
 [logger_SimulateCommand]
 qualname = SimulateCommand
-level = NOTSET    ; Default: WARNING
-handlers = app    ; Default: stderr
-propagate = 0     ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; Default: 1
+propagate = 0
 
 [logger_SumCommand]
 qualname = SumCommand
-level = NOTSET    ; Default: WARNING
-handlers = splunklib    ; Default: stderr
-propagate = 0     ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
 
 [handlers]
 # See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html)

examples/searchcommands_template/default/logging.conf

@@ -7,20 +7,31 @@
 keys = root, splunklib, %(command.title())Command
 
 [logger_root]
-level = WARNING   ; Default: WARNING
-handlers = stderr ; Default: stderr
+; Default: WARNING
+level = WARNING
+; Default: stderr
+handlers = stderr
 
 [logger_splunklib]
 qualname = splunklib
-level = NOTSET        ; Default: WARNING
-handlers = splunklib  ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
+
+[logger_SearchCommand]
+qualname = SearchCommand
 
 [logger_%(command.title())Command]
 qualname = %(command.title())Command
-level = NOTSET    ; Default: WARNING
-handlers = app    ; Default: stderr
-propagate = 0     ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; default: 1
+propagate = 0
 
 [handler_app]
 # Select this handler to log events to $SPLUNK_HOME/var/log/splunk/searchcommands_app.log

tests/searchcommands/__init__.py

@@ -19,27 +19,22 @@
 
 from sys import version_info as python_version
 
-if not (python_version[0] == 2 and python_version[1] == 7):
-    def load_tests(loader, tests, pattern):
-        return
-else:
-    from os import path
-    import logging
+from os import path
+import logging
 
-    from splunklib.searchcommands import environment
-    from splunklib import searchcommands
+from splunklib.searchcommands import environment
+from splunklib import searchcommands
 
-    package_directory = path.dirname(path.realpath(__file__))
-    project_root = path.dirname(path.dirname(package_directory))
+package_directory = path.dirname(path.realpath(__file__))
+project_root = path.dirname(path.dirname(package_directory))
 
 
-    def rebase_environment(name):
+def rebase_environment(name):
+    environment.app_root = path.join(package_directory, 'apps', name)
+    logging.Logger.manager.loggerDict.clear()
+    del logging.root.handlers[:]
 
-        environment.app_root = path.join(package_directory, 'apps', name)
-        logging.Logger.manager.loggerDict.clear()
-        del logging.root.handlers[:]
-
-        environment.splunklib_logger, environment.logging_configuration = environment.configure_logging('splunklib')
-        searchcommands.logging_configuration = environment.logging_configuration
-        searchcommands.splunklib_logger = environment.splunklib_logger
-        searchcommands.app_root = environment.app_root
+    environment.splunklib_logger, environment.logging_configuration = environment.configure_logging('splunklib')
+    searchcommands.logging_configuration = environment.logging_configuration
+    searchcommands.splunklib_logger = environment.splunklib_logger
+    searchcommands.app_root = environment.app_root

tests/searchcommands/apps/app_with_logging_configuration/default/alternative-logging.conf

@@ -7,20 +7,28 @@
 keys = root, splunklib, SearchCommand
 
 [logger_root]
-level = WARNING       ; Default: WARNING
-handlers = stderr     ; Default: stderr
+; Default: WARNING
+level = WARNING
+; Default: stderr
+handlers = stderr
 
 [logger_splunklib]
 qualname = splunklib
-level = NOTSET        ; Default: WARNING
-handlers = splunklib  ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
 
 [logger_SearchCommand]
 qualname = SearchCommand
-level = NOTSET        ; Default: WARNING
-handlers = app        ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; default: 1
+propagate = 0
 
 [handlers]
 # See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html)

tests/searchcommands/apps/app_with_logging_configuration/default/logging.conf

@@ -7,20 +7,28 @@
 keys = root, splunklib, SearchCommand
 
 [logger_root]
-level = WARNING       ; Default: WARNING
-handlers = stderr     ; Default: stderr
+; Default: WARNING
+level = WARNING
+; Default: stderr
+handlers = stderr
 
 [logger_splunklib]
 qualname = splunklib
-level = NOTSET        ; Default: WARNING
-handlers = splunklib  ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
 
 [logger_SearchCommand]
 qualname = SearchCommand
-level = NOTSET        ; Default: WARNING
-handlers = app        ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; default: 1
+propagate = 0
 
 [handlers]
 # See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html)

tests/searchcommands/apps/app_with_logging_configuration/logging.conf

@@ -7,20 +7,28 @@
 keys = root, splunklib, SearchCommand
 
 [logger_root]
-level = WARNING       ; Default: WARNING
-handlers = stderr     ; Default: stderr
+; Default: WARNING
+level = WARNING
+; Default: stderr
+handlers = stderr
 
 [logger_splunklib]
 qualname = splunklib
-level = NOTSET        ; Default: WARNING
-handlers = splunklib  ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = splunklib
+; Default: 1
+propagate = 0
 
 [logger_SearchCommand]
 qualname = SearchCommand
-level = NOTSET        ; Default: WARNING
-handlers = app        ; Default: stderr
-propagate = 0         ; Default: 1
+; Default: WARNING
+level = NOTSET
+; Default: stderr
+handlers = app
+; Default: 1
+propagate = 0
 
 [handlers]
 # See [logging.handlers](https://docs.python.org/2/library/logging.handlers.html)

tests/searchcommands/test_builtin_options.py

@@ -33,14 +33,15 @@
 from splunklib.searchcommands.decorators import Configuration
 from splunklib.searchcommands.search_command import SearchCommand
 
-try:
-    from tests.searchcommands import rebase_environment, package_directory
-except:
-    # Skip on Python 2.6
-    def rebase_environment(ignore):
-        return
-    pass
+from tests.searchcommands import rebase_environment, package_directory
 
+# portable log level names
+# https://stackoverflow.com/a/49724281
+def level_names():
+    return [logging.getLevelName(v) for v in
+            sorted(getattr(logging, '_levelToName', None)
+                    or logging._levelNames)
+            if getattr(v, "real", 0)]
 
 @Configuration()
 class StubbedSearchCommand(SearchCommand):
@@ -62,23 +63,20 @@ def test_logging_configuration(self):
 
         rebase_environment('app_without_logging_configuration')
 
-        self.assertIsInstance(environment.splunklib_logger, logging.Logger)
-        self.assertIsNone(environment.logging_configuration)
-        self.assertEqual(len(logging.root.handlers), 1)
-        self.assertEqual(len(logging.Logger.manager.loggerDict), 1)
-        self.assertIsInstance(logging.root.handlers[0], logging.StreamHandler)
-        self.assertIs(environment.splunklib_logger, logging.getLogger('splunklib'))
         self.assertIsNone(environment.logging_configuration)
+        self.assertTrue(any(isinstance(h, logging.StreamHandler) for h in logging.root.handlers))
+        self.assertTrue('splunklib' in logging.Logger.manager.loggerDict)
+        self.assertEqual(environment.splunklib_logger, logging.Logger.manager.loggerDict['splunklib'])
+        self.assertIsInstance(environment.splunklib_logger, logging.Logger)
 
         command = StubbedSearchCommand()
 
         self.assertIs(command.logger, logging.getLogger('StubbedSearchCommand'))
         self.assertEqual(len(command.logger.handlers), 0)
         self.assertIsNone(command.logging_configuration)
         self.assertIs(command.logger.root, logging.root)
-        self.assertEqual(len(logging.root.handlers), 1)
 
-        root_handler = logging.root.handlers[0]
+        root_handler = next(h for h in logging.root.handlers if isinstance(h, logging.StreamHandler))
 
         self.assertIsInstance(root_handler, logging.StreamHandler)
         self.assertEqual(root_handler.stream, sys.stderr)
@@ -147,7 +145,7 @@ def test_logging_level(self):
 
         self.assertEqual(warning, command.logging_level)
 
-        for level in logging._levelNames:
+        for level in level_names():
             if type(level) is int:
                 command.logging_level = level
                 level_name = logging.getLevelName(level)
@@ -201,9 +199,8 @@ def _test_boolean_option(self, option):
 
         for value in boolean_values:
             for variant in value, value.capitalize(), value.upper():
-                for s in variant, bytes(variant):
-                    option.fset(command, s)
-                    self.assertEqual(option.fget(command), boolean_values[value])
+                option.fset(command, variant)
+                self.assertEqual(option.fget(command), boolean_values[value])
 
         option.fset(command, None)
         self.assertEqual(option.fget(command), None)

tests/searchcommands/test_validators.py

@@ -52,8 +52,8 @@ def test_boolean(self):
 
         for value in truth_values:
             for variant in value, value.capitalize(), value.upper():
-                for s in six.text_type(variant), bytes(variant):
-                    self.assertEqual(validator.__call__(s), truth_values[value])
+                s = six.text_type(variant)
+                self.assertEqual(validator.__call__(s), truth_values[value])
 
         self.assertIsNone(validator.__call__(None))
         self.assertRaises(ValueError, validator.__call__, 'anything-else')