x/packstack
Code Issues Proposed changes

Added value processing capability for plugins.

Browse Source 
Fixes Issue #23.
This commit is contained in:
Martin Magr
2012-12-17 14:57:36 +01:00
parent 2e9aefb315
commit 782806985b
5 changed files with 195 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
packstack/installer/common_utils.py
View File

@@ -1,3 +1,5 @@
# -*- coding: utf-8 -*-
"""
contains all common and re-usable code for rhevm-setup and sub packages
"""
@@ -6,15 +8,25 @@ import pwd
import logging
import subprocess
import re
import output_messages
import traceback
import os
import basedefs
import datetime
import types
import time
import socket
import tempfile
import basedefs
import output_messages
class UtilsError(Exception):
pass
class UtilsNetworkError(UtilsError):
pass
def getColoredText (text, color):
''' gets text string and color
and returns a colored text.
@@ -290,6 +302,71 @@ def installed(rpm):
def returnYes(controller):
return "yes"
def getLocalhostIP():
"""
Returns IP address of localhost.
"""
# TO-DO: Will probably need to find better way to find out localhost
# address.
# find nameservers
ns_regex = re.compile('nameserver\s*(?P<ns_ip>[\d\.\:])')
resolv, rc = execCmd(['cat /etc/resolv.conf | grep nameserver',],
failOnError=False, useShell=True)
nsrvs = []
for line in resolv.split('\n'):
match = ns_regex.match(line.strip())
if match:
nsrvs.append(match.group('ns_ip'))
# try to connect to nameservers and return own IP address
nsrvs.append('8.8.8.8') # default to google dns
for i in nsrvs:
try:
s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
s.connect((i, 0))
loc_ip = s.getsockname()[0]
except socket.error:
continue
else:
return loc_ip
def host2ip(hostname, allow_localhost=False):
"""
Converts given hostname to IP address. Raises HostnameConvertError
if conversion failed.
"""
try:
ip_list = socket.gethostbyaddr(hostname)[2]
if allow_localhost:
return ip_list[0]
else:
local_ips = ('127.0.0.1', '::1')
for ip in ip_list:
if ip not in local_ips:
break
else:
raise NameError()
return ip
except NameError:
# given hostname is localhost, return appropriate IP address
ip = getLocalhostIP()
if not ip:
raise UtilsNetworkError('Failed to get local IP address.')
return ip
except socket.error:
raise UtilsNetworkError('Unknown hostname %s.' % hostname)
except Exception, ex:
raise UtilsNetworkError('Unknown error appeared: %s' % repr(ex))
def forceIP(host, allow_localhost=False):
host = host.strip()
ipv4_regex = re.compile('\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}')
ipv6_regex = re.compile('[abcdef\d\:]+')
if not ipv4_regex.match(host) or not ipv6_regex.match(host):
host = host2ip(host, allow_localhost=allow_localhost)
return host
class ScriptRunner(object):
def __init__(self, ip=None):
self.script = []
@@ -304,10 +381,10 @@ class ScriptRunner(object):
if not False: #config.justprint:
_PIPE = subprocess.PIPE # pylint: disable=E1101
if self.ip:
obj = subprocess.Popen(["ssh", "-o", "StrictHostKeyChecking=no", "-o", "UserKnownHostsFile=/dev/null", "root@%s"%self.ip, "bash -x"], stdin=_PIPE, stdout=_PIPE, stderr=_PIPE,
obj = subprocess.Popen(["ssh", "-o", "StrictHostKeyChecking=no", "-o", "UserKnownHostsFile=/dev/null", "root@%s"%self.ip, "bash -x"], stdin=_PIPE, stdout=_PIPE, stderr=_PIPE,
close_fds=True, shell=False)
else:
obj = subprocess.Popen(["bash", "-x"], stdin=_PIPE, stdout=_PIPE, stderr=_PIPE,
obj = subprocess.Popen(["bash", "-x"], stdin=_PIPE, stdout=_PIPE, stderr=_PIPE,
close_fds=True, shell=False)
logging.debug(script)
@@ -320,7 +397,7 @@ class ScriptRunner(object):
if logerrors:
logging.error("============= STDERR ==========")
logging.error(stderrdata)
else:
else:
logging.debug("============= STDERR ==========")
logging.debug(stderrdata)
raise Exception("Error running remote script")
@@ -336,5 +413,3 @@ class ScriptRunner(object):
def ifexists(self, fn, s):
self.append("[ -e %s ] && %s"%(fn, s))

23
packstack/installer/engine_processors.py Normal file
View File

@@ -0,0 +1,23 @@
# -*- coding: utf-8 -*-
from .common_utils import UtilsNetworkError, forceIP
__all__ = ('ParamProcessingError', 'processHost')
class ParamProcessingError(Exception):
pass
def processHost(param, process_args=None):
"""
Given parameter is a hostname, try to change it to IP address
"""
localhost = process_args and \
process_args.get('allow_localhost', False)
try:
return forceIP(param, allow_localhost=localhost)
except UtilsNetworkError, ex:
raise ParamProcessingError(str(ex))

9
packstack/installer/engine_validators.py
View File

@@ -13,6 +13,12 @@ import os.path
import tempfile
from setup_controller import Controller
# XXX: Validators should probably only validate (pass on success,
# raise appropriate exception on failure). We should move logging
# and printing probably to run_setup (preferably to single place)
def validateDirSize(path, size):
availableSpace = utils.getAvailableSpace(_getBasePath(path))
if availableSpace < size:
@@ -360,8 +366,7 @@ def r_validateDevice(server, device=None):
# if it is mounted then the mount point has to be in /srv/node
server.append('grep "/dev/%s /srv/node" /proc/self/mounts && exit 0'%device)
# if we got here without exiting then we can't use this device
server.append('exit 1')
return False

11
packstack/installer/output_messages.py
View File

@@ -40,6 +40,13 @@ INFO_VAL_PORT_OCCUPIED="Error: TCP Port %s is already open by %s (pid: %s)"
INFO_VAL_PORT_OCCUPIED_BY_JBOSS="Error: TCP Port %s is used by JBoss"
INFO_VAL_PASSWORD_DONT_MATCH="Error: passwords don't match"
INFO_VAL_IS_HOSTNAME = ("Packstack changed given hostname %s to IP "
"address %s.")
WARN_VAL_IS_HOSTNAME = ("Warning: Packstack failed to change given "
"hostname %s to IP address. Note that some "
"services might not run correctly when hostname"
" is used.")
INFO_STRING_LEN_LESS_THAN_MIN="String length is less than the minimum allowed: %s"
INFO_STRING_EXCEEDS_MAX_LENGTH="String length exceeds the maximum length allowed: %s"
INFO_STRING_CONTAINS_ILLEGAL_CHARS="String contains illegal characters"
@@ -70,7 +77,7 @@ ERR_EXP_FAILED_INIT_LOGGER="Unexpected error: Failed to initiate logger, please
ERR_RC_CODE="Return Code is not zero"
ERR_FAILURE="General failure"
ERR_NO_ANSWER_FILE="Error: Could not find file %s"
ERR_ONLY_1_FLAG="Error: The %s flag is mutually exclusive to all other command line options"
#
#
INFO_KEYSTONERC="To use the command line tools simply source the keystonerc_* files created here"

83
packstack/installer/run_setup.py
View File

@@ -16,6 +16,7 @@ from optparse import OptionParser, OptionGroup
import basedefs
import common_utils as utils
import engine_validators as validate
import engine_processors as process
import output_messages
from setup_controller import Controller
@@ -28,7 +29,15 @@ commandLineValues = {}
#TODO: read default values from conf_param?
masked_value_set = set()
def initLogging():
class InstallError(Exception):
pass
class FlagValidationError(InstallError):
pass
def initLogging(level='INFO'):
global logFile
try:
#in order to use UTC date for the log file, send True to getCurrentDateTime(True)
@@ -36,7 +45,7 @@ def initLogging():
logFile = os.path.join(basedefs.DIR_LOG,logFilename)
if not os.path.isdir(os.path.dirname(logFile)):
os.makedirs(os.path.dirname(logFile))
level = logging.INFO
level = getattr(logging, level)
hdlr = logging.FileHandler(filename = logFile, mode='w')
fmts='%(asctime)s::%(levelname)s::%(module)s::%(lineno)d::%(name)s:: %(message)s'
dfmt='%Y-%m-%d %H:%M:%S'
@@ -63,7 +72,7 @@ def initSequences():
def setDebug():
if controller.CONF['CONFIG_DEBUG'] == 'y':
logging.root.setLevel(logging.DEBUG)
logging.root.setLevel(logging.DEBUG) # XXX: this doesn't work at all, will have to refactor
def initConfig():
"""
@@ -162,6 +171,36 @@ def _getInputFromUser(param):
if userInput == "" and len(param.getKey("DEFAULT_VALUE")) > 0:
userInput = param.getKey("DEFAULT_VALUE")
# Param processing
try:
logging.debug("Processing value of parameter "
"%s." % param.getKey("CONF_NAME"))
processFunc = param.getKey("PROCESSOR_FUNC")
try:
processArgs = param.getKey("PROCESSOR_ARGS")
except KeyError:
processArgs = None
try:
_userInput = processFunc(userInput, processArgs)
if userInput != _userInput:
msg = output_messages.INFO_VAL_IS_HOSTNAME
print msg % (userInput, _userInput)
userInput = _userInput
else:
logging.debug("Processor returned the original "
"value: %s" % _userInput)
except process.ParamProcessingError, ex:
try:
cn = param.getKey("CONF_NAME")
msg = param.getKey("PROCESSOR_MSG")
print getattr(output_messages, msg) % cn
except KeyError:
logging.debug("Value processing of parameter "
"%s failed." % param.getKey("CONF_NAME"))
except KeyError:
logging.debug("Parameter %s doesn't have value "
"processor." % param.getKey("CONF_NAME"))
# If param requires validation
if param.getKey("VALIDATION_FUNC")(userInput, param.getKey("OPTION_LIST")):
if "yes" in param.getKey("OPTION_LIST") and userInput.lower() == "y":
@@ -320,6 +359,29 @@ def _validateParamValue(param, paramValue):
if not validateFunc(paramValue, optionsList):
raise Exception(output_messages.ERR_EXP_VALIDATE_PARAM % param.getKey("CONF_NAME"))
def _processParamValue(param, paramValue):
try:
processFunc = param.getKey("PROCESSOR_FUNC")
except KeyError:
return paramValue
try:
processArgs = param.getKey("PROCESSOR_ARGS")
except KeyError:
processArgs = None
logging.debug("processing param %s in answer file." % param.getKey("CONF_NAME"))
try:
return processFunc(paramValue, processArgs)
except process.ParamProcessingError, ex:
cn = param.getKey("CONF_NAME")
logging.debug("processing param %s failed, falling back to "
"original, reason: %s" % (cn, ex))
try:
msg = param.getKey("PROCESSOR_MSG")
print getattr(output_messages, msg) % cn
except KeyError:
pass
return paramValue
def _handleGroupCondition(config, conditionName, conditionValue):
"""
handle params group pre/post condition
@@ -354,6 +416,7 @@ def _loadParamFromFile(config, section, paramName):
# Validate param value using its validation func
param = controller.getParamByName(paramName)
value = _processParamValue(param, value)
_validateParamValue(param, value)
# Keep param value in our never ending global conf
@@ -691,7 +754,7 @@ def loadPlugins():
"""
sys.path.append(basedefs.DIR_PLUGINS)
sys.path.append(basedefs.DIR_MODULES)
fileList = [f for f in os.listdir(basedefs.DIR_PLUGINS) if f[0] != "_"]
fileList = sorted(fileList, cmp=plugin_compare)
for item in fileList:
@@ -736,10 +799,9 @@ def countCmdLineFlags(options, flag):
def validateSingleFlag(options, flag):
counter = countCmdLineFlags(options, flag)
if counter > 0:
optParser.print_help()
print
#replace _ with - for printing's sake
raise Exception(output_messages.ERR_ONLY_1_FLAG % "--%s" % flag.replace("_","-"))
flag = flag.replace("_","-")
msg = output_messages.ERR_ONLY_1_FLAG % ("--%s" % flag)
raise FlagValidationError(msg)
def initPluginsConfig():
@@ -806,12 +868,15 @@ def main():
except SystemExit:
raise
except FlagValidationError, ex:
optParser.print_help()
print
except BaseException as e:
logging.error(traceback.format_exc())
print e
print output_messages.ERR_CHECK_LOG_FILE_FOR_MORE_INFO%(logFile)
sys.exit(1)
if __name__ == "__main__":
main()