def test_builtin_options(self):
# logging_level accepts all logging levels and returns their canonical
# string values
warning = logging.getLevelName(logging.WARNING)
notset = logging.getLevelName(logging.NOTSET)
logging.root.setLevel(logging.WARNING)
while len(logging.root.handlers) > 0:
logging.root.removeHandler(logging.root.handlers[0])
command = SearchCommand()
self.assertEquals(warning, command.logging_level)
for level in logging._levelNames:
if type(level) is int:
command.logging_level = level
level_name = logging.getLevelName(level)
self.assertEquals(command.logging_level, warning if level_name == notset else level_name)
else:
level_name = logging.getLevelName(logging.getLevelName(level))
for variant in level, level.lower(), level.capitalize():
command.logging_level = variant
self.assertEquals(command.logging_level, warning if level_name == notset else level_name)
# logging_level accepts any numeric value
for level in 999, 999.999:
command.logging_level = level
self.assertEqual(command.logging_level, 'Level 999')
# logging_level raises a value error for unknown logging level names
current_value = command.logging_level
try:
command.logging_level = 'foo'
except ValueError:
pass
except BaseException as e:
self.fail('Expected ValueError, but %s was raised' % type(e))
else:
self.fail('Expected ValueError, but logging_level=%s' % command.logging_level)
self.assertEqual(command.logging_level, current_value)
app_root = os.path.join(TestDecorators._package_directory, 'data', 'app')
command = SearchCommand() # guarantee: no logging.conf
directory = os.getcwd()
os.chdir(os.path.join(app_root, 'bin'))
try:
# In the absence of a logging.conf file, messages are written to
# stderr
self.assertEqual(len(logging.root.handlers), 1)
root_handler = logging.root.handlers[0]
self.assertIsInstance(root_handler, logging.StreamHandler)
self.assertEqual(root_handler.stream, sys.stderr)
self.assertEqual(len(command.logger.handlers), 0)
# TODO: capture this output and verify it
command.logger.warning('Test that output is directed to stderr without formatting')
default_logging_configuration = os.path.join(directory, app_root, 'default', 'logging.conf')
# A search command loads {local,default}/logging.conf when it is
# available
command = SearchCommand() # guarantee: default/logging.conf
self.assertEqual(command.logging_configuration, default_logging_configuration)
# logging_configuration loads a new logging configuration file
# relative to the app root
command.logging_configuration = 'logging.conf'
self.assertEqual(command.logging_configuration, default_logging_configuration)
# logging_configuration loads a new logging configuration file on an
# absolute path
command.logging_configuration = default_logging_configuration
self.assertEqual(command.logging_configuration, default_logging_configuration)
# logging_configuration raises a value error, if a non-existent
# logging configuration file is provided
try:
command.logging_configuration = 'foo'
except ValueError:
pass
except BaseException as e:
self.fail('Expected ValueError, but %s was raised' % type(e))
else:
self.fail('Expected ValueError, but logging_configuration=%s' % command.logging_configuration)
try:
command.logging_configuration = os.path.join(TestDecorators._package_directory, 'non-existent.logging.conf')
except ValueError:
pass
except BaseException as e:
self.fail('Expected ValueError, but %s was raised' % type(e))
else:
self.fail('Expected ValueError, but logging_configuration=%s' % command.logging_configuration)
finally:
os.chdir(directory)
# show_configuration accepts Splunk boolean values
boolean_values = {
'0': False, '1': True,
'f': False, 't': True,
'n': False, 'y': True,
'no': False, 'yes': True,
'false': False, 'true': True}
for value in boolean_values:
for variant in [value, value.capitalize(), value.upper()]:
command.show_configuration = variant
self.assertEquals(command.show_configuration, boolean_values[value])
for value in 'any-other-string', 13:
try:
command.show_configuration = value
except ValueError:
pass
except BaseException as e:
self.fail('Expected ValueError, but %s was raised' % type(e))
else:
self.fail('Expected ValueError, but show_configuration=%s' % command.show_configuration)
# SearchCommandParser recognizes each built-in option
for argv in ['logging_level=DEBUG'], ['show_configuration=true']:
parser = SearchCommandParser()
parser.parse(argv, command)
return
