def test_get_plugin_history(self):
config = copy.deepcopy(self.config)
smokerd = Smokerd(config=self.conf_dir + '/smokerd.yaml')
smokerd.pluginmgr = server_plugins.PluginManager(**config)
restserver.smokerd = smokerd
plugin = smokerd.pluginmgr.get_plugin('Uname')
for i in range(4):
plugin.forced = True
plugin.run()
time.sleep(0.5)
plugin.collect_new_result()
plugin_history = restserver.get_plugin_history('Uname')
assert len(plugin_history) == 4
def test_load_config_with_invalid_yaml_format(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
with open(yaml_file, 'w') as fp:
fp.write('plugins InvalidFormat')
with pytest.raises(AttributeError) as exc_info:
Smokerd(config=yaml_file)
assert "'str' object has no attribute 'items'" in repr(exc_info.value)
os.remove(yaml_file)
with open(yaml_file, 'w') as fp:
fp.write('- plugins InvalidFormat')
with pytest.raises(AttributeError) as exc_info:
Smokerd(config=yaml_file)
assert "'list' object has no attribute 'items'" in repr(exc_info.value)
os.remove(yaml_file)
def test_load_config(self):
yaml_file = self.conf_dir + '/smokerd.yaml'
expected_plugins = copy.deepcopy(self.expected_plugins)
expected = dict(expected_plugins, **copy.deepcopy(self.expected_basic))
expected['config'] = yaml_file
smokerd = Smokerd(config=yaml_file)
assert smokerd.conf == expected
def main():
parser = argparse.ArgumentParser(description='Smoke testing daemon')
parser.add_argument('-c', '--config', dest='config', default='/etc/smokerd/smokerd.yaml', help="Config file to use (default /etc/smokerd/smokerd.yaml)")
parser.add_argument('-p', '--pidfile', dest='pidfile', default='/var/run/smokerd.pid', help="PID file to use (default /var/run/smokerd.pid)")
parser.add_argument('-fg', '--foreground', dest='foreground', action='store_true', help="Don't fork into background")
parser.add_argument('--stop', dest='stop', action='store_true', help="Stop currently running daemon")
parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help="Be verbose")
parser.add_argument('-d', '--debug', dest='debug', action='store_true', help="Debug output")
args = parser.parse_args()
# Don't log into console if we are going to background
if not args.foreground:
lg = smoker.logger.init(console=False)
else:
lg = smoker.logger.init()
if args.verbose:
lg.setLevel(logging.INFO)
if args.debug:
lg.setLevel(logging.DEBUG)
daemon = Smokerd(
config = args.config,
pidfile = args.pidfile
)
if args.stop:
daemon.stop()
sys.exit(0)
if args.foreground:
daemon.run()
else:
daemon.daemonize()
def test_load_config_with_invalid_include_dir_path(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
with open(yaml_file, 'w') as fp:
fp.write('plugins: !include_dir /InvalidFilePath')
smokerd = Smokerd(config=yaml_file)
assert 'plugins' in smokerd.conf
assert not smokerd.conf['plugins']
os.remove(yaml_file)
def test_load_config_with_include_dir_only(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
expected = copy.deepcopy(self.expected_plugins)
expected['config'] = yaml_file
with open(yaml_file, 'w') as fp:
fp.write('plugins: !include_dir %s/plugins' % self.conf_dir)
smokerd = Smokerd(config=yaml_file)
os.remove(yaml_file)
assert smokerd.conf == expected
def test_load_config_with_invalid_include_file_path(self):
expected = 'No such file or directory'
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
with open(yaml_file, 'w') as fp:
fp.write('plugins: !include /InvalidFilePath')
with pytest.raises(IOError) as exc_info:
Smokerd(config=yaml_file)
assert expected in repr(exc_info.value)
os.remove(yaml_file)
def main():
parser = argparse.ArgumentParser(
description='Smoke testing daemon',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument(
'-c', '--config', dest='config', default='/etc/smokerd/smokerd.yaml',
help="Config file to be used")
parser.add_argument(
'-p', '--pidfile', dest='pidfile', default='/var/run/smokerd.pid',
help="PID file to be used")
parser.add_argument(
'--logging-conf', dest='logging_conf',
default='/etc/smokerd/logging.ini', help="Path to logging config file")
parser.add_argument('-fg', '--foreground', dest='foreground',
action='store_true', help="Don't fork into background")
parser.add_argument('--stop', dest='stop', action='store_true',
help="Stop currently running daemon")
parser.add_argument('--no-syslog', dest='no_syslog', action='store_true',
help=("Don't use syslog handler. Not effective when "
"logging config file is used."))
parser.add_argument('--no-console', dest='no_console', action='store_true',
help="Don't use console handler.")
parser.add_argument('-v', '--verbose', dest='verbose', action='store_true',
help="Be verbose")
parser.add_argument('-d', '--debug', dest='debug', action='store_true',
help="Debug output")
args = parser.parse_args()
logging_args = {'config_file': args.logging_conf}
# Don't log into console if we are going to background
if not args.foreground or args.no_console:
logging_args['console'] = False
if args.no_syslog:
logging_args['syslog'] = False
lg = smoker.logger.init(**logging_args)
if args.verbose:
lg.setLevel(logging.INFO)
if args.debug:
lg.setLevel(logging.DEBUG)
daemon = Smokerd(config=args.config, pidfile=args.pidfile)
if args.stop:
daemon.stop()
sys.exit(0)
if args.foreground:
daemon.run()
else:
daemon.daemonize()
def test_load_config_with_include_dir(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
expected = copy.deepcopy(self.expected_plugins)
expected['config'] = yaml_file
expected['bind_host'] = '0.0.0.0'
expected['bind_port'] = 8086
with open(yaml_file, 'w') as fp:
fp.write('plugins: !include_dir %s/plugins\n' % self.conf_dir)
fp.write('bind_host: 0.0.0.0\n')
fp.write('bind_port: 8086\n')
smokerd = Smokerd(config=yaml_file)
os.remove(yaml_file)
assert smokerd.conf == expected
def main():
parser = argparse.ArgumentParser(
description="Smoke testing daemon", formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
parser.add_argument(
"-c", "--config", dest="config", default="/etc/smokerd/smokerd.yaml", help="Config file to be used"
)
parser.add_argument("-p", "--pidfile", dest="pidfile", default="/var/run/smokerd.pid", help="PID file to be used")
parser.add_argument(
"--logging-conf", dest="logging_conf", default="/etc/smokerd/logging.ini", help="Path to logging config file"
)
parser.add_argument(
"-fg", "--foreground", dest="foreground", action="store_true", help="Don't fork into background"
)
parser.add_argument("--stop", dest="stop", action="store_true", help="Stop currently running daemon")
parser.add_argument(
"--no-syslog",
dest="no_syslog",
action="store_true",
help=("Don't use syslog handler. Not effective when " "logging config file is used."),
)
parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", help="Be verbose")
parser.add_argument("-d", "--debug", dest="debug", action="store_true", help="Debug output")
args = parser.parse_args()
logging_args = {"config_file": args.logging_conf}
# Don't log into console if we are going to background
if not args.foreground:
logging_args["console"] = False
if args.no_syslog:
logging_args["syslog"] = False
lg = smoker.logger.init(**logging_args)
if args.verbose:
lg.setLevel(logging.INFO)
if args.debug:
lg.setLevel(logging.DEBUG)
daemon = Smokerd(config=args.config, pidfile=args.pidfile)
if args.stop:
daemon.stop()
sys.exit(0)
if args.foreground:
daemon.run()
else:
daemon.daemonize()
def test_load_config_with_include_files(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
expected = copy.deepcopy(self.expected_plugins)
expected['config'] = yaml_file
conf_plugins = [
'plugins:',
' hostname: !include %s/plugins/hostname.yaml' % self.conf_dir,
' uptime: !include %s/plugins/uptime.yaml' % self.conf_dir,
' uname: !include %s/plugins/uname.yaml' % self.conf_dir
]
with open(yaml_file, 'w') as fp:
fp.write('\n'.join(conf_plugins))
smokerd = Smokerd(config=yaml_file)
os.remove(yaml_file)
assert smokerd.conf == expected
def main():
parser = argparse.ArgumentParser(description='Smoke testing daemon')
parser.add_argument('-c', '--config', dest='config', default='/etc/smokerd/smokerd.yaml', help="Config file to use (default /etc/smokerd/smokerd.yaml)")
parser.add_argument('-p', '--pidfile', dest='pidfile', default='/var/run/smokerd.pid', help="PID file to use (default /var/run/smokerd.pid)")
parser.add_argument('-fg', '--foreground', dest='foreground', action='store_true', help="Don't fork into background")
parser.add_argument('--stop', dest='stop', action='store_true', help="Stop currently running daemon")
parser.add_argument('--no-syslog', dest='no_syslog', action='store_true', help="Don't use syslog handler")
parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', help="Be verbose")
parser.add_argument('-d', '--debug', dest='debug', action='store_true', help="Debug output")
args = parser.parse_args()
logging_args = {}
# Don't log into console if we are going to background
if not args.foreground:
logging_args['console'] = False
if args.no_syslog:
logging_args['syslog'] = False
lg = smoker.logger.init(**logging_args)
if args.verbose:
lg.setLevel(logging.INFO)
if args.debug:
lg.setLevel(logging.DEBUG)
daemon = Smokerd(
config = args.config,
pidfile = args.pidfile
)
if args.stop:
daemon.stop()
sys.exit(0)
if args.foreground:
daemon.run()
else:
daemon.daemonize()
def test_load_config_with_include(self):
yaml_file = '%s/%s.yaml' % (self.conf_dir, generate_unique_file())
conf_smokerd = open(self.conf_dir + '/smokerd_basic.yaml', 'r').read()
expected_plugins = copy.deepcopy(self.expected_plugins)
expected = dict(expected_plugins, **copy.deepcopy(self.expected_basic))
expected['config'] = yaml_file
conf_plugins = [
'plugins:',
' hostname: !include %s/plugins/hostname.yaml' % self.conf_dir,
' uptime: !include %s/plugins/uptime.yaml' % self.conf_dir,
' uname: !include %s/plugins/uname.yaml' % self.conf_dir
]
conf_smokerd += '\n'.join(conf_plugins)
with open(yaml_file, 'w') as fp:
fp.write(conf_smokerd)
smokerd = Smokerd(config=yaml_file)
os.remove(yaml_file)
assert smokerd.conf == expected
def main():
parser = argparse.ArgumentParser(
description='Smoke testing daemon',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('-c',
'--config',
dest='config',
default='/etc/smokerd/smokerd.yaml',
help="Config file to be used")
parser.add_argument('-p',
'--pidfile',
dest='pidfile',
default='/var/run/smokerd.pid',
help="PID file to be used")
parser.add_argument('--logging-conf',
dest='logging_conf',
default='/etc/smokerd/logging.ini',
help="Path to logging config file")
parser.add_argument('-fg',
'--foreground',
dest='foreground',
action='store_true',
help="Don't fork into background")
parser.add_argument('--stop',
dest='stop',
action='store_true',
help="Stop currently running daemon")
parser.add_argument('--no-syslog',
dest='no_syslog',
action='store_true',
help=("Don't use syslog handler. Not effective when "
"logging config file is used."))
parser.add_argument('--no-console',
dest='no_console',
action='store_true',
help="Don't use console handler.")
parser.add_argument('-v',
'--verbose',
dest='verbose',
action='store_true',
help="Be verbose")
parser.add_argument('-d',
'--debug',
dest='debug',
action='store_true',
help="Debug output")
args = parser.parse_args()
logging_args = {'config_file': args.logging_conf}
# Don't log into console if we are going to background
if not args.foreground or args.no_console:
logging_args['console'] = False
if args.no_syslog:
logging_args['syslog'] = False
lg = smoker.logger.init(**logging_args)
if args.verbose:
lg.setLevel(logging.INFO)
if args.debug:
lg.setLevel(logging.DEBUG)
daemon = Smokerd(config=args.config, pidfile=args.pidfile)
if args.stop:
daemon.stop()
sys.exit(0)
if args.foreground:
daemon.run()
else:
daemon.daemonize()
class TestRestAPI(object):
"""Unit tests for the restserver functions"""
component_result = {
'componentResults': {
'Unit tests': {
'status': 'OK',
'messages': {
'info': ['GoodData'],
'warn': [],
'error': []
}
}
}
}
conf_plugins = {
'Uptime ': {
'Category': 'monitoring',
'Command': 'uptime'
},
'Uname': {
'Category': 'system',
'Module': 'smoker.server.plugins.uname'
},
'Hostname': {
'Category': 'system',
'Command': 'hostname'
}
}
conf_templates = {
'BasePlugin': {
'Interval': 1,
'gid': 'default',
'uid': 'default',
'Timeout': 30,
'History': 10
}
}
config = {
'plugins': conf_plugins,
'templates': conf_templates,
'actions': dict()
}
conf_dir = (os.path.dirname(os.path.realpath(__file__)) +
'/smoker_test_resources/smokerd')
smokerd = Smokerd(config=conf_dir + '/smokerd.yaml')
# Map smokerd.pluginmgr to PluginManager instance
# because we don't 'run' smokerd instance (work arround)
smokerd.pluginmgr = server_plugins.PluginManager(**config)
restserver.smokerd = smokerd
def test_next_run_iso_format_boolean_input(self):
assert restserver.next_run_iso_format(True) is None
def test_next_run_iso_format_time_input(self):
sample = datetime.datetime.now()
next_run = restserver.next_run_iso_format(sample)
assert next_run
assert next_run == sample.isoformat()
assert isinstance(next_run, str)
def test_standardized_api_list_null_input(self):
assert not restserver.standardized_api_list(None)
def test_standardized_api_list_invalid_type_input(self):
component_result = ['component', 'InvalidInput']
result = restserver.standardized_api_list(component_result)
assert result
assert result == component_result
assert isinstance(result, list)
def test_standardized_api_list_missing_componentResults_keyword(self):
component_result = {'InvalidKeyword': 'Smoker'}
result = restserver.standardized_api_list(component_result)
assert result
assert result == component_result
assert isinstance(result, dict)
def test_standardized_api_list_valid_input(self):
expected = {
'componentResults': [{
'componentResult': {
'status': 'OK',
'messages': {
'info': ['GoodData'],
'warn': [],
'error': []
},
'name': 'Unit tests'
}
}]
}
result = restserver.standardized_api_list(self.component_result)
assert result
assert result == expected
assert isinstance(result, dict)
def test_print_plugin(self):
plugin_result = restserver.print_plugin('Uname')
assert plugin_result['plugin']
assert plugin_result['plugin']['name'] == 'Uname'
assert plugin_result['plugin']['links']['self'] == '/plugins/Uname'
assert plugin_result['plugin']['parameters']
def test_print_plugin_with_invalid_plugin_name(self):
with pytest.raises(smoker_exceptions.NoSuchPlugin) as exc_info:
restserver.print_plugin('InvalidPluginName')
assert 'Plugin InvalidPluginName not found' in repr(exc_info.value)
def test_forced_print_plugin_without_forced_result(self):
with pytest.raises(smoker_exceptions.InProgress):
restserver.print_plugin('Uname', forced=True)
def test_forced_print_plugin_with_forced_result(self):
plugin = self.smokerd.pluginmgr.get_plugin('Uname')
plugin.forced = True
plugin.run()
time.sleep(0.5)
plugin_result = restserver.print_plugin('Uname', forced=True)
assert plugin_result['plugin']
assert plugin_result['plugin']['name'] == 'Uname'
assert plugin_result['plugin']['links']['self'] == '/plugins/Uname'
assert plugin_result['plugin']['parameters']
assert plugin_result['plugin']['forcedResult']['status'] == 'OK'
assert plugin_result['plugin']['forcedResult']['forced'] is True
assert plugin_result['plugin']['forcedResult']['messages']['info']
def test_print_plugins(self):
plugins_to_print = list(self.conf_plugins.keys())
plugins_result = restserver.print_plugins(plugins_to_print)
assert plugins_result['plugins']
assert len(plugins_result['plugins']['items']) == len(plugins_to_print)
for plugin_name in plugins_to_print:
index = plugins_to_print.index(plugin_name)
plugin_result = plugins_result['plugins']['items'][index]['plugin']
assert plugin_result['name'] == plugin_name
assert plugin_result['links']['self'] == '/plugins/' + plugin_name
assert plugin_result['parameters']
def test_forced_print_plugins_with_forced_result(self):
plugins_to_print = list(self.conf_plugins.keys())
for plugin in self.smokerd.pluginmgr.get_plugins().values():
plugin.forced = True
plugin.run()
time.sleep(0.5)
plugins_result = restserver.print_plugins(plugins_to_print,
forced=True)
assert plugins_result['plugins']
assert len(plugins_result['plugins']['items']) == len(plugins_to_print)
for plugin_name in plugins_to_print:
index = plugins_to_print.index(plugin_name)
plugin_result = plugins_result['plugins']['items'][index]['plugin']
assert plugin_result['name'] == plugin_name
assert plugin_result['links']['self'] == '/plugins/' + plugin_name
assert plugin_result['parameters']
assert plugin_result['forcedResult']['status'] == 'OK'
assert plugin_result['forcedResult']['forced'] is True
assert plugin_result['forcedResult']['messages']['info']
def test_get_plugin_history(self):
config = copy.deepcopy(self.config)
smokerd = Smokerd(config=self.conf_dir + '/smokerd.yaml')
smokerd.pluginmgr = server_plugins.PluginManager(**config)
restserver.smokerd = smokerd
plugin = smokerd.pluginmgr.get_plugin('Uname')
for i in range(4):
plugin.forced = True
plugin.run()
time.sleep(0.5)
plugin.collect_new_result()
plugin_history = restserver.get_plugin_history('Uname')
assert len(plugin_history) == 4
def test_reset_smokerd_instance(self):
# To prevent data changed from test_get_plugin_history in smokerd
config = copy.deepcopy(self.config)
self.smokerd = Smokerd(config=self.conf_dir + '/smokerd.yaml')
self.smokerd.pluginmgr = server_plugins.PluginManager(**config)
restserver.smokerd = self.smokerd
def test_reset_smokerd_instance(self):
# To prevent data changed from test_get_plugin_history in smokerd
config = copy.deepcopy(self.config)
self.smokerd = Smokerd(config=self.conf_dir + '/smokerd.yaml')
self.smokerd.pluginmgr = server_plugins.PluginManager(**config)
restserver.smokerd = self.smokerd
def test_load_config_with_invalid_file_path(self):
expected = 'No such file or directory'
with pytest.raises(IOError) as exc_info:
Smokerd(config='InvalidFilePath')
assert expected in repr(exc_info.value)