# vim: tabstop=4 shiftwidth=4 softtabstop=4 # Copyright (C) 2012 Yahoo! Inc. All Rights Reserved. # # Copyright 2011 OpenStack LLC. # All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import json import netifaces import os import platform import random import re import sys import termcolor from devstack import exceptions as excp from devstack import log as logging from devstack import settings from devstack import shell as sh from devstack import version PARAM_SUB_REGEX = re.compile(r"%([\w\d]+?)%") EXT_COMPONENT = re.compile(r"^\s*([\w-]+)(?:\((.*)\))?\s*$") MONTY_PYTHON_TEXT_RE = re.compile("([a-z0-9A-Z!.,'\"]+)") LOG = logging.getLogger("devstack.util") TEMPLATE_EXT = ".tpl" def load_template(component, fn): full_pth = sh.joinpths(settings.STACK_CONFIG_DIR, component, fn + TEMPLATE_EXT) contents = sh.load_file(full_pth) return (full_pth, contents) def execute_template(*cmds, **kargs): params_replacements = kargs.pop('params', None) tracewriter = kargs.pop('tracewriter', None) ignore_missing = kargs.pop('ignore_missing', False) cmd_results = list() for cmdinfo in cmds: cmd_to_run_templ = cmdinfo.get("cmd") if not cmd_to_run_templ: continue cmd_to_run = list() if not params_replacements: cmd_to_run = cmd_to_run_templ else: for piece in cmd_to_run_templ: cmd_to_run.append(param_replace(str(piece), params_replacements, ignore_missing=ignore_missing)) stdin_templ = cmdinfo.get('stdin') stdin = None if stdin_templ: stdin_full = list() if not params_replacements: stdin_full = stdin_templ else: for piece in stdin_templ: stdin_full.append(param_replace(str(piece), params_replacements, ignore_missing=ignore_missing)) stdin = joinlinesep(*stdin_full) exec_result = sh.execute(*cmd_to_run, run_as_root=cmdinfo.get('run_as_root', False), process_input=stdin, **kargs) if tracewriter: tracewriter.exec_cmd(cmd_to_run, exec_result) cmd_results.append(exec_result) return cmd_results def to_bytes(text): byte_val = 0 if not text: return byte_val if text[-1].upper() == 'G': byte_val = int(text[:-1]) * 1024 ** 3 elif text[-1].upper() == 'M': byte_val = int(text[:-1]) * 1024 ** 2 elif text[-1].upper() == 'K': byte_val = int(text[:-1]) * 1024 elif text[-1].upper() == 'B': byte_val = int(text[:-1]) else: byte_val = int(text) return byte_val def import_module(module_name): try: __import__(module_name) return sys.modules.get(module_name, None) except ImportError: return None def load_json(fn): data = sh.load_file(fn) lines = data.splitlines() new_lines = list() for line in lines: if line.lstrip().startswith('#'): continue new_lines.append(line) data = joinlinesep(*new_lines) return json.loads(data) def get_host_ip(def_net_ifcs, def_ip_version): ip = None ifc = None interfaces = get_interfaces() for net_ifc in def_net_ifcs: def_info = interfaces.get(net_ifc) if def_info: ipinfo = def_info.get(def_ip_version) if ipinfo: ip = ipinfo.get('addr') ifc = net_ifc if ip: break if ip is None: ifcs = ", ".join(def_net_ifcs) msg = "Your host does not have an ip address on interfaces [%s] using ip version: %s!" % (ifcs, def_ip_version) raise excp.NoIpException(msg) return (ip, ifc) def get_interfaces(): interfaces = dict() for intfc in netifaces.interfaces(): interface_info = dict() interface_addresses = netifaces.ifaddresses(intfc) ip6 = interface_addresses.get(netifaces.AF_INET6) if ip6 and len(ip6): #just take the first interface_info[settings.IPV6] = ip6[0] ip4 = interface_addresses.get(netifaces.AF_INET) if ip4 and len(ip4): #just take the first interface_info[settings.IPV4] = ip4[0] #there are others but this is good for now interfaces[intfc] = interface_info return interfaces def determine_distro(): plt = platform.platform() #ensure its a linux distro (distname, _, _) = platform.linux_distribution() if not distname: return (None, plt) #attempt to match it to our platforms found_os = None for (known_os, pattern) in settings.KNOWN_DISTROS.items(): if pattern.search(plt): found_os = known_os break return (found_os, plt) def extract_pip_list(fns, distro, all_pips=None): if not all_pips: all_pips = dict() for fn in fns: js = load_json(fn) distro_pips = js.get(distro) if distro_pips: all_pips.update(distro_pips) return all_pips def extract_pkg_list(fns, distro, all_pkgs=None): if not all_pkgs: all_pkgs = dict() for fn in fns: js = load_json(fn) distro_pkgs = js.get(distro) if distro_pkgs: all_pkgs.update(distro_pkgs) return all_pkgs def get_components_order(components): if not components: return dict() #deep copy so components isn't messed with all_components = dict() for (name, deps) in components.items(): all_components[name] = set(deps) #figure out which ones have no one depending on them no_deps_components = set() for (name, deps) in all_components.items(): referenced = False for (_name, _deps) in all_components.items(): if _name == name: continue else: if name in _deps: referenced = True break if not referenced: no_deps_components.add(name) if not no_deps_components: msg = "Components specifed have no root components, there is most likely a dependency cycle!" raise excp.DependencyException(msg) #now we have to do a quick check to ensure no component is causing a cycle for (root, deps) in all_components.items(): #DFS down through the "roots" deps and there deps and so on and #ensure that nobody is referencing the "root" component name, #that would mean there is a cycle if a dependency of the "root" is. active_deps = list(deps) checked_deps = dict() while len(active_deps): dep = active_deps.pop() itsdeps = all_components.get(dep) checked_deps[dep] = True if root in itsdeps: msg = "Circular dependency between component %s and component %s!" % (root, dep) raise excp.DependencyException(msg) else: for d in itsdeps: if d not in checked_deps and d not in active_deps: active_deps.append(d) #now form the order #basically a topological sorting #https://en.wikipedia.org/wiki/Topological_sorting ordering = list() no_edges = set(no_deps_components) while len(no_edges): node = no_edges.pop() ordering.append(node) its_deps = all_components.get(node) while len(its_deps): name = its_deps.pop() referenced = False for (_name, _deps) in all_components.items(): if _name == name: continue else: if name in _deps: referenced = True break if not referenced: no_edges.add(name) #should now be no edges else something bad happended for (_, deps) in all_components.items(): if len(deps): msg = "Your specified components have at least one cycle!" raise excp.DependencyException(msg) #reverse so its in the right order for us since we just determined #the pkgs that have no one depending on them (which should be installed #last and those that have incoming edges that packages are depending on need #to go first, but those were inserted last), so this reverse fixes that ordering.reverse() return ordering def joinlinesep(*pieces): return os.linesep.join(pieces) def param_replace(text, replacements, ignore_missing=False): if not replacements: return text if not text: return text if ignore_missing: LOG.debug("Performing parameter replacements (ignoring missing) on text [%s]" % (text)) else: LOG.debug("Performing parameter replacements (not ignoring missing) on text [%s]" % (text)) def replacer(match): org = match.group(0) name = match.group(1) v = replacements.get(name) if v is None and ignore_missing: v = org elif v is None and not ignore_missing: msg = "No replacement found for parameter %s" % (org) raise excp.NoReplacementException(msg) else: LOG.debug("Replacing [%s] with [%s]" % (org, str(v))) return str(v) return PARAM_SUB_REGEX.sub(replacer, text) def _get_welcome_stack(): possibles = list() #thank you figlet ;) possibles.append(r''' ___ ____ _____ _ _ ____ _____ _ ____ _ __ / _ \| _ \| ____| \ | / ___|_ _|/ \ / ___| |/ / | | | | |_) | _| | \| \___ \ | | / _ \| | | ' / | |_| | __/| |___| |\ |___) || |/ ___ \ |___| . \ \___/|_| |_____|_| \_|____/ |_/_/ \_\____|_|\_\ ''') possibles.append(r''' ___ ___ ___ _ _ ___ _____ _ ___ _ __ / _ \| _ \ __| \| / __|_ _/_\ / __| |/ / | (_) | _/ _|| .` \__ \ | |/ _ \ (__| ' < \___/|_| |___|_|\_|___/ |_/_/ \_\___|_|\_\ ''') possibles.append(r''' ____ ___ ____ _ _ ____ ___ ____ ____ _ _ | | |__] |___ |\ | [__ | |__| | |_/ |__| | |___ | \| ___] | | | |___ | \_ ''') possibles.append(r''' _ ___ ___ _ _ __ ___ _ __ _ _ / \| o \ __|| \| |/ _||_ _|/ \ / _|| |// ( o ) _/ _| | \\ |\_ \ | || o ( (_ | ( \_/|_| |___||_|\_||__/ |_||_n_|\__||_|\\ ''') possibles.append(r''' _ ___ ___ _ __ ___ _____ _ __ _ ,' \ / o |/ _/ / |/ /,' _//_ _/.' \ ,'_/ / //7 / o |/ _,'/ _/ / || /_\ `. / / / o // /_ / ,' |_,'/_/ /___//_/|_//___,' /_/ /_n_/ |__//_/\\ ''') possibles.append(r''' _____ ___ ___ _ _ ___ _____ _____ ___ _ _ ( _ )( _`\ ( _`\ ( ) ( )( _`\(_ _)( _ )( _`\ ( ) ( ) | ( ) || |_) )| (_(_)| `\| || (_(_) | | | (_) || ( (_)| |/'/' | | | || ,__/'| _)_ | , ` |`\__ \ | | | _ || | _ | , < | (_) || | | (_( )| |`\ |( )_) | | | | | | || (_( )| |\`\ (_____)(_) (____/'(_) (_)`\____) (_) (_) (_)(____/'(_) (_) ''') return random.choice(possibles).strip("\n\r") def center_text(text, fill, max_len): centered_str = '{0:{fill}{align}{size}}'.format(text, fill=fill, align="^", size=max_len) return centered_str def _welcome_slang(): potentials = list() potentials.append("And now for something completely different!") return random.choice(potentials).strip("\n\r") def color_text(text, color, bold=False, underline=False, blink=False): text_attrs = list() if bold: text_attrs.append('bold') if underline: text_attrs.append('underline') if blink: text_attrs.append('blink') return termcolor.colored(text, color, attrs=text_attrs) def _color_blob(text, text_color): def replacer(match): contents = match.group(1) return color_text(contents, text_color) return MONTY_PYTHON_TEXT_RE.sub(replacer, text) def _goodbye_header(worked): #cowsay headers potentials_oks = list() potentials_oks.append(r''' ___________ / You shine \ | out like | | a shaft | | of gold | | when all | | around is | \ dark. / ----------- ''') potentials_oks.append(r''' ______________________________ < I'm a lumberjack and I'm OK. > ------------------------------ ''') potentials_oks.append(r''' ____________________ / Australia! \ | Australia! | | Australia! | \ We love you, amen. / -------------------- ''') potentials_oks.append(r''' ______________ / Say no more, \ | Nudge nudge | \ wink wink. / -------------- ''') potentials_oks.append(r''' __________ < Success! > ----------''') potentials_fails = list() potentials_fails.append(r''' __________ < Failure! > ---------- ''') potentials_fails.append(r''' ___________ < Run away! > ----------- ''') potentials_fails.append(r''' ______________________ / NOBODY expects the \ \ Spanish Inquisition! / ---------------------- ''') potentials_fails.append(r''' ______________________ / Spam spam spam spam \ \ baked beans and spam / ---------------------- ''') potentials_fails.append(r''' ____________________ / Brave Sir Robin \ \ ran away. / -------------------- ''') potentials_fails.append(r''' _______________________ < Message for you, sir. > ----------------------- ''') potentials_fails.append(r''' ____________________ / We are the knights \ \ who say.... NI! / -------------------- ''') potentials_fails.append(r''' ____________________ / Now go away or I \ | shall taunt you a | \ second time. / -------------------- ''') potentials_fails.append(r''' ____________________ / It's time for the \ | penguin on top of | | your television to | \ explode. / -------------------- ''') potentials_fails.append(r''' _____________________ / We were in the nick \ | of time. You were | \ in great peril. / --------------------- ''') potentials_fails.append(r''' ___________________ / I know a dead \ | parrot when I see | | one, and I'm | | looking at one | \ right now. / ------------------- ''') potentials_fails.append(r''' _________________ / Welcome to the \ | National Cheese | \ Emporium / ----------------- ''') if not worked: msg = random.choice(potentials_fails).strip("\n\r") colored_msg = _color_blob(msg, 'red') else: msg = random.choice(potentials_oks).strip("\n\r") colored_msg = _color_blob(msg, 'green') return colored_msg def goodbye(worked): #thx cowsay cow = r''' {header} \ {ear}__{ear} \ ({eye}{eye})\_______ (__)\ )\/\ ||----w | || || ''' cow = cow.strip("\n\r") ear = '^' eye_fmt = 'o' if not worked: eye_fmt = color_text("o", 'red') ear = color_text(ear, 'red') header = _goodbye_header(worked) msg = cow.format(eye=eye_fmt, ear=ear, header=header) print(msg) def parse_components(components): #none provided, init it if not components: components = list() adjusted_components = dict() for c in components: mtch = EXT_COMPONENT.match(c) if mtch: component_name = mtch.group(1).lower().strip() if component_name in settings.COMPONENT_NAMES: component_opts = mtch.group(2) components_opts_cleaned = list() if component_opts: sp_component_opts = component_opts.split(",") for co in sp_component_opts: cleaned_opt = co.strip() if cleaned_opt: components_opts_cleaned.append(cleaned_opt) adjusted_components[component_name] = components_opts_cleaned return adjusted_components def welcome(ident): lower = "| %s %s |" % (ident, version.version_string()) welcome_header = _get_welcome_stack() max_line_len = len(max(welcome_header.splitlines(), key=len)) footer = color_text(settings.PROG_NICE_NAME, 'green') footer += ": " footer += color_text(lower, 'blue', True) uncolored_footer = (settings.PROG_NICE_NAME + ": " + lower) if max_line_len - len(uncolored_footer) > 0: #this format string will center the uncolored text which #we will then replace with the color text equivalent centered_str = center_text(uncolored_footer, " ", max_line_len) footer = centered_str.replace(uncolored_footer, footer) print(welcome_header) print(footer) real_max = max(max_line_len, len(uncolored_footer)) slang = center_text(_welcome_slang(), ' ', real_max) print(color_text(slang, 'magenta', bold=True)) return ("-", real_max)