def test_30_ip_addresses():
conf = load_conf(os.path.join(TESTS_DIR, 'conf.yaml'))
hosts_conf = load_conf(os.path.join(TESTS_DIR, 'hosts.yaml'))
hosts_manager = HostsManager(conf, hosts_conf, log)
assert [ '192.168.1.110', '192.168.1.111', '192.168.1.112' ] \
== hosts_manager.ip_addresses(tags=[ 'slave_db' ]),\
"ip_addresses > tags"
def test_20_host_names():
conf = load_conf(os.path.join(TESTS_DIR, 'conf.yaml'))
hosts_conf = load_conf(os.path.join(TESTS_DIR, 'hosts.yaml'))
hosts_manager = HostsManager(conf, hosts_conf, log)
assert [ 'web01', 'web02', 'web03', 'mdb01', 'sdb01', 'sdb02', 'sdb03' ] == hosts_manager.host_names(),\
"host_names > all"
assert [ 'web03' ] == hosts_manager.host_names(tags=[ 'web', 'master_db' ], statuses=[ 'dead' ]),\
"host_names > tags, statuses"
def create_invalid_hosts_manager(conf_file, hosts_conf_file):
return HostsManager(
load_conf(conf_file),
load_conf(hosts_conf_file),
log
)
def create_valid_hosts_manager():
return HostsManager(
load_conf(valid_conf_file),
load_conf(valid_hosts_conf_file),
log
)
def __init__(self, file, conf_dir, commandline_args=sys.argv[1:]):
log = None
env_debug = os.getenv('BTFLY_DEBUG') or '0'
if env_debug == '1' or env_debug.lower() == 'true':
log = create_logger(True)
else:
log = create_logger(False)
self._log = log
log.debug("PYTHON_PATH = " + str(sys.path))
parser = argparse.ArgumentParser(
prog = os.path.basename(file),
description = "A micro host management program.",
conflict_handler = 'resolve'
)
default_conf_path = os.path.join(conf_dir, 'conf.yaml')
parser.add_argument(
'-c', '--conf', default=default_conf_path,
help='Configuration file path. (default: %s)' % (default_conf_path)
)
parser.add_argument(
'--conf-url', help='Configuration file url.'
)
default_hosts_conf_path = self.default_hosts_conf_path(conf_dir)
parser.add_argument(
'-h', '--hosts-conf', default=default_hosts_conf_path,
help='Hosts configuration file path. (default: %s)' % (default_hosts_conf_path)
)
parser.add_argument(
'--hosts-conf-url', help='Hosts configuration file url.'
)
parser.add_argument(
'-s', '--statuses', help='Specify statues.'
)
parser.add_argument(
'-t', '--tags', help='Specify tags.'
)
parser.add_argument(
'-f', '--field', help='Specify a field.'
)
parser.add_argument(
'-o', '--output-file', type=argparse.FileType('w'),
help='Specify a file path to output. Default behavior is outputing to stdout.'
)
parser.add_argument(
'-D', '--debug', action='store_true', default=False,
help='Enable debug output.',
)
parser.add_argument(
'--version', action='version',
version='%(prog)s ' + __version__
+ ' with Python ' + '.'.join(map(str, sys.version_info[0:3])),
)
self._conf_dir = conf_dir
self._file = file
plugin_manager = PluginManager(log, parser)
# Load plugins
plugin_manager.load_plugins(self.plugin_dirs(conf_dir))
log.debug("All plugins are registered.")
self._arg_parser = parser
self._args = parser.parse_args(commandline_args)
self._options = self._args.__dict__
self._plugin_manager = plugin_manager
# Load configuration
conf = load_url_conf(self._options['conf_url'])
if conf == None:
conf = load_conf(self._options['conf'])
hosts_conf = load_url_conf(self._options['hosts_conf_url'])
if hosts_conf == None:
hosts_conf = load_conf(self._options['hosts_conf'])
self._hosts_manager = HostsManager(conf, hosts_conf, self._log)
validation_errors = self._hosts_manager.validate(
self._options['conf'], self._options['hosts_conf']
)
if validation_errors:
for e in validation_errors:
print >> sys.stderr, e.message
raise RuntimeError("There are some errors in configuration files.")
error = False
if self._options.get('statuses'):
# Check given --statuses are defined.
conf_statuses = conf.get('statuses')
option_statuses_list = [ s.strip() for s in self._options.get('statuses').split(',') ]
statuses_list = []
for s in option_statuses_list:
if s in conf_statuses:
statuses_list.append(s)
else:
print >>sys.stderr, "status '%s' is not defined in configuration." % (s)
error = True
self._options['statuses_list'] = statuses_list
if error:
raise ValueError("Option --statuses error")
if self._options.get('tags'):
# Check given --tags are defined.
conf_tags = conf.get('tags')
tags_list = [ s.strip() for s in self._options.get('tags').split(',') ]
tags = []
for t in tags_list:
if t in [ conf_tag.keys()[0] for conf_tag in conf_tags ]:
tags.append(t)
else:
print >>sys.stderr, "tag '%s' is not defined in configuration." % (s)
error = True
self._options['tags'] = tags
if error:
raise ValueError("Option --tags error")
class Main(object):
def __init__(self, file, conf_dir, commandline_args=sys.argv[1:]):
log = None
env_debug = os.getenv('BTFLY_DEBUG') or '0'
if env_debug == '1' or env_debug.lower() == 'true':
log = create_logger(True)
else:
log = create_logger(False)
self._log = log
log.debug("PYTHON_PATH = " + str(sys.path))
parser = argparse.ArgumentParser(
prog = os.path.basename(file),
description = "A micro host management program.",
conflict_handler = 'resolve'
)
default_conf_path = os.path.join(conf_dir, 'conf.yaml')
parser.add_argument(
'-c', '--conf', default=default_conf_path,
help='Configuration file path. (default: %s)' % (default_conf_path)
)
parser.add_argument(
'--conf-url', help='Configuration file url.'
)
default_hosts_conf_path = self.default_hosts_conf_path(conf_dir)
parser.add_argument(
'-h', '--hosts-conf', default=default_hosts_conf_path,
help='Hosts configuration file path. (default: %s)' % (default_hosts_conf_path)
)
parser.add_argument(
'--hosts-conf-url', help='Hosts configuration file url.'
)
parser.add_argument(
'-s', '--statuses', help='Specify statues.'
)
parser.add_argument(
'-t', '--tags', help='Specify tags.'
)
parser.add_argument(
'-f', '--field', help='Specify a field.'
)
parser.add_argument(
'-o', '--output-file', type=argparse.FileType('w'),
help='Specify a file path to output. Default behavior is outputing to stdout.'
)
parser.add_argument(
'-D', '--debug', action='store_true', default=False,
help='Enable debug output.',
)
parser.add_argument(
'--version', action='version',
version='%(prog)s ' + __version__
+ ' with Python ' + '.'.join(map(str, sys.version_info[0:3])),
)
self._conf_dir = conf_dir
self._file = file
plugin_manager = PluginManager(log, parser)
# Load plugins
plugin_manager.load_plugins(self.plugin_dirs(conf_dir))
log.debug("All plugins are registered.")
self._arg_parser = parser
self._args = parser.parse_args(commandline_args)
self._options = self._args.__dict__
self._plugin_manager = plugin_manager
# Load configuration
conf = load_url_conf(self._options['conf_url'])
if conf == None:
conf = load_conf(self._options['conf'])
hosts_conf = load_url_conf(self._options['hosts_conf_url'])
if hosts_conf == None:
hosts_conf = load_conf(self._options['hosts_conf'])
self._hosts_manager = HostsManager(conf, hosts_conf, self._log)
validation_errors = self._hosts_manager.validate(
self._options['conf'], self._options['hosts_conf']
)
if validation_errors:
for e in validation_errors:
print >> sys.stderr, e.message
raise RuntimeError("There are some errors in configuration files.")
error = False
if self._options.get('statuses'):
# Check given --statuses are defined.
conf_statuses = conf.get('statuses')
option_statuses_list = [ s.strip() for s in self._options.get('statuses').split(',') ]
statuses_list = []
for s in option_statuses_list:
if s in conf_statuses:
statuses_list.append(s)
else:
print >>sys.stderr, "status '%s' is not defined in configuration." % (s)
error = True
self._options['statuses_list'] = statuses_list
if error:
raise ValueError("Option --statuses error")
if self._options.get('tags'):
# Check given --tags are defined.
conf_tags = conf.get('tags')
tags_list = [ s.strip() for s in self._options.get('tags').split(',') ]
tags = []
for t in tags_list:
if t in [ conf_tag.keys()[0] for conf_tag in conf_tags ]:
tags.append(t)
else:
print >>sys.stderr, "tag '%s' is not defined in configuration." % (s)
error = True
self._options['tags'] = tags
if error:
raise ValueError("Option --tags error")
def run(self, out=None):
# load tasks
self._log.debug("options = %s" % (self._options))
task = self._plugin_manager.task(self._options.get('task'))
if not isinstance(task, BaseTask):
raise ValueError("task '%s' is not instance of BaseTask." % task)
field = self._options.get('field') or 'name'
context = Context(
self._conf_dir,
self._options,
self._hosts_manager,
field
)
output = self._args.func(context)
should_close = False
if out is None:
out = self._options.get('output_file')
if out is None:
out = sys.stdout
else:
should_close = True
try:
print >>out, output
finally:
if should_close:
try:
out.close()
except IOError:
pass
# eval `BTFLY_ENV=production btfly --tags web --field ip env`
# --> btfly_hosts=(127.0.0.1 192.168.1.2)
# % btfly-foreach; do ssh $i uptime; done
#
# `BTFLY_ENV=production btfly --tags web --field ip csv`
# --> 127.0.0.1,192.168.1.2
# % tomahawk -h `BTFLY_ENV=production btfly --tags web --field ip tomahawk_hosts` \
# -p 4 -c -t 30 '/etc/init.d/httpd stop'
#
# btfly-rsync pigg_files /usr/local/pigg_files/
def default_hosts_conf_path(self, conf_dir):
path = None
if os.getenv('BTFLY_ENV'):
# If BTFLY_ENV=production is defined, load 'hosts_production.yaml'
path = os.path.join(conf_dir, 'hosts_%s.yaml' % os.getenv('BTFLY_ENV'))
if not os.path.isfile(path):
#self._log.warn("%s doesn't exist." % path)
path = None
if not path:
path = os.path.join(conf_dir, 'hosts.yaml')
return path
def plugin_dirs(self, conf_dir):
plugin_dirs = []
plugin_path = os.getenv('BTFLY_PLUGIN_PATH')
if plugin_path:
for path in plugin_path.split(os.pathsep):
if os.path.isdir(path):
plugin_dirs.append(path)
else:
self._log.warn("Plugin path '%s' not found. Ignored." % path)
# Append default plugin pathes
parent, dir = os.path.split(os.path.abspath(conf_dir))
for path in ( os.path.join(parent, 'plugins'), '/etc/btfly/plugins' ):
if os.path.isdir(path):
plugin_dirs.append(path)
self._log.debug("plugin_dirs = %s" % plugin_dirs)
if len(plugin_dirs) == 0:
raise ValueError("Cannot find any plugin directories.")
return plugin_dirs
