blob: d282203d4500bbf31b2b8e51f07cd67700c411c7 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyerdff49a22014-01-30 15:37:40 -06003# functions-common - Common functions used by DevStack components
4#
5# The canonical copy of this file is maintained in the DevStack repo.
6# All modifications should be made there and then sync'ed to other repos
7# as required.
8#
9# This file is sorted alphabetically within the function groups.
10#
11# - Config Functions
12# - Control Functions
13# - Distro Functions
14# - Git Functions
15# - OpenStack Functions
16# - Package Functions
17# - Process Functions
Dean Troyerdff49a22014-01-30 15:37:40 -060018# - Service Functions
Masayuki Igawaf6368d32014-02-20 13:31:26 +090019# - System Functions
Dean Troyerdff49a22014-01-30 15:37:40 -060020#
21# The following variables are assumed to be defined by certain functions:
22#
23# - ``ENABLED_SERVICES``
24# - ``ERROR_ON_CLONE``
25# - ``FILES``
26# - ``OFFLINE``
Dean Troyerdff49a22014-01-30 15:37:40 -060027# - ``RECLONE``
Masayuki Igawad20f6322014-02-28 09:22:37 +090028# - ``REQUIREMENTS_DIR``
29# - ``STACK_USER``
Dean Troyerdff49a22014-01-30 15:37:40 -060030# - ``TRACK_DEPENDS``
31# - ``http_proxy``, ``https_proxy``, ``no_proxy``
Dean Troyer3324f192014-09-18 09:26:39 -050032#
Dean Troyerdff49a22014-01-30 15:37:40 -060033
34# Save trace setting
35XTRACE=$(set +o | grep xtrace)
36set +o xtrace
37
Ian Wienand4ffb4542015-06-30 11:00:32 +100038# ensure we don't re-source this in the same environment
39[[ -z "$_DEVSTACK_FUNCTIONS_COMMON" ]] || return 0
40declare -r _DEVSTACK_FUNCTIONS_COMMON=1
41
Sean Daguecc524062014-10-01 09:06:43 -040042# Global Config Variables
43declare -A GITREPO
44declare -A GITBRANCH
45declare -A GITDIR
46
Sean Dague53753292014-12-04 19:38:15 -050047TRACK_DEPENDS=${TRACK_DEPENDS:-False}
48
Dean Troyer68162342015-05-13 15:41:03 -050049# Save these variables to .stackenv
50STACK_ENV_VARS="BASE_SQL_CONN DATA_DIR DEST ENABLED_SERVICES HOST_IP \
51 KEYSTONE_AUTH_PROTOCOL KEYSTONE_AUTH_URI KEYSTONE_SERVICE_URI \
Brian Haley180f5eb2015-06-16 13:14:31 -040052 LOGFILE OS_CACERT SERVICE_HOST SERVICE_PROTOCOL STACK_USER TLS_IP \
Brian Haley5d04db22015-06-16 13:14:31 -040053 HOST_IPV6 SERVICE_IP_VERSION"
Dean Troyer68162342015-05-13 15:41:03 -050054
55
56# Saves significant environment variables to .stackenv for later use
57# Refers to a lot of globals, only TOP_DIR and STACK_ENV_VARS are required to
58# function, the rest are simply saved and do not cause problems if they are undefined.
59# save_stackenv [tag]
60function save_stackenv {
61 local tag=${1:-""}
62 # Save some values we generated for later use
63 time_stamp=$(date "+$TIMESTAMP_FORMAT")
64 echo "# $time_stamp $tag" >$TOP_DIR/.stackenv
65 for i in $STACK_ENV_VARS; do
66 echo $i=${!i} >>$TOP_DIR/.stackenv
67 done
68}
Dean Troyerdff49a22014-01-30 15:37:40 -060069
Monty Taylor7224eec2015-09-19 11:26:18 -040070# Update/create user clouds.yaml file.
71# clouds.yaml will have
72# - A `devstack` entry for the `demo` user for the `demo` project.
73# - A `devstack-admin` entry for the `admin` user for the `admin` project.
74# write_clouds_yaml
75function write_clouds_yaml {
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +030076 local clouds_yaml
Monty Taylor7224eec2015-09-19 11:26:18 -040077
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +030078 sudo mkdir -p /etc/openstack
79 sudo chown -R $STACK_USER /etc/openstack
80 # XXX: to be removed, see https://review.openstack.org/237149/
81 # careful not to sudo this, incase ~ is NFS mounted
82 mkdir -p ~/.config/openstack
83
84 for clouds_path in /etc/openstack ~/.config/openstack ; do
85 clouds_yaml=$clouds_path/clouds.yaml
Monty Taylor7224eec2015-09-19 11:26:18 -040086
Monty Taylor8f385dd2015-10-19 15:13:30 -040087 CA_CERT_ARG=''
88 if [ -f "$SSL_BUNDLE_FILE" ]; then
89 CA_CERT_ARG="--os-cacert $SSL_BUNDLE_FILE"
90 fi
91 $TOP_DIR/tools/update_clouds_yaml.py \
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +030092 --file $clouds_yaml \
Monty Taylor8f385dd2015-10-19 15:13:30 -040093 --os-cloud devstack \
94 --os-region-name $REGION_NAME \
95 --os-identity-api-version 3 \
96 $CA_CERT_ARG \
97 --os-auth-url $KEYSTONE_AUTH_URI \
98 --os-username demo \
99 --os-password $ADMIN_PASSWORD \
100 --os-project-name demo
101 $TOP_DIR/tools/update_clouds_yaml.py \
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +0300102 --file $clouds_yaml \
Monty Taylor8f385dd2015-10-19 15:13:30 -0400103 --os-cloud devstack-admin \
104 --os-region-name $REGION_NAME \
105 --os-identity-api-version 3 \
106 $CA_CERT_ARG \
107 --os-auth-url $KEYSTONE_AUTH_URI \
108 --os-username admin \
109 --os-password $ADMIN_PASSWORD \
110 --os-project-name admin
111 done
Monty Taylor7224eec2015-09-19 11:26:18 -0400112}
113
Ian Wienande82bac02015-08-25 14:29:08 +1000114# trueorfalse <True|False> <VAR>
115#
116# Normalize config-value provided in variable VAR to either "True" or
117# "False". If VAR is unset (i.e. $VAR evaluates as empty), the value
118# of the second argument will be used as the default value.
119#
120# Accepts as False: 0 no No NO false False FALSE
121# Accepts as True: 1 yes Yes YES true True TRUE
122#
123# usage:
124# VAL=$(trueorfalse False VAL)
Ian Wienandaee18c72014-02-21 15:35:08 +1100125function trueorfalse {
Ian Wienand433a9b12015-10-07 13:29:31 +1100126 local xtrace
127 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -0500128 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600129
Mahito OGURA98f59aa2015-05-11 18:02:34 +0900130 local default=$1
Ian Wienande82bac02015-08-25 14:29:08 +1000131
132 if [ -z $2 ]; then
133 die $LINENO "variable to normalize required"
134 fi
Mahito OGURA98f59aa2015-05-11 18:02:34 +0900135 local testval=${!2:-}
136
137 case "$testval" in
138 "1" | [yY]es | "YES" | [tT]rue | "TRUE" ) echo "True" ;;
139 "0" | [nN]o | "NO" | [fF]alse | "FALSE" ) echo "False" ;;
140 * ) echo "$default" ;;
141 esac
142
Sean Dague45917cc2014-02-24 16:09:14 -0500143 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600144}
145
Attila Fazekas1bd79592015-02-24 14:06:56 +0100146function isset {
147 [[ -v "$1" ]]
148}
Dean Troyerdff49a22014-01-30 15:37:40 -0600149
Dean Troyer68162342015-05-13 15:41:03 -0500150
Dean Troyerdff49a22014-01-30 15:37:40 -0600151# Control Functions
152# =================
153
154# Prints backtrace info
155# filename:lineno:function
156# backtrace level
157function backtrace {
158 local level=$1
Ian Wienandada886d2015-10-07 14:06:26 +1100159 local deep
160 deep=$((${#BASH_SOURCE[@]} - 1))
Dean Troyerdff49a22014-01-30 15:37:40 -0600161 echo "[Call Trace]"
162 while [ $level -le $deep ]; do
163 echo "${BASH_SOURCE[$deep]}:${BASH_LINENO[$deep-1]}:${FUNCNAME[$deep-1]}"
164 deep=$((deep - 1))
165 done
166}
167
168# Prints line number and "message" then exits
169# die $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100170function die {
Dean Troyerdff49a22014-01-30 15:37:40 -0600171 local exitcode=$?
172 set +o xtrace
173 local line=$1; shift
174 if [ $exitcode == 0 ]; then
175 exitcode=1
176 fi
177 backtrace 2
178 err $line "$*"
Dean Troyera25a6f62014-02-24 16:03:41 -0600179 # Give buffers a second to flush
180 sleep 1
Dean Troyerdff49a22014-01-30 15:37:40 -0600181 exit $exitcode
182}
183
184# Checks an environment variable is not set or has length 0 OR if the
185# exit code is non-zero and prints "message" and exits
186# NOTE: env-var is the variable name without a '$'
187# die_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100188function die_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600189 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100190 local xtrace
191 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600192 set +o xtrace
193 local line=$1; shift
194 local evar=$1; shift
195 if ! is_set $evar || [ $exitcode != 0 ]; then
196 die $line "$*"
197 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500198 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600199}
200
Sean Dague1de9e332015-10-07 08:46:13 -0400201function deprecated {
202 local text=$1
203 DEPRECATED_TEXT+="\n$text"
204 echo "WARNING: $text"
205}
206
Dean Troyerdff49a22014-01-30 15:37:40 -0600207# Prints line number and "message" in error format
208# err $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100209function err {
Dean Troyerdff49a22014-01-30 15:37:40 -0600210 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100211 local xtrace
212 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600213 set +o xtrace
214 local msg="[ERROR] ${BASH_SOURCE[2]}:$1 $2"
215 echo $msg 1>&2;
Dean Troyerdde41d02014-12-09 17:47:57 -0600216 if [[ -n ${LOGDIR} ]]; then
217 echo $msg >> "${LOGDIR}/error.log"
Dean Troyerdff49a22014-01-30 15:37:40 -0600218 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500219 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600220 return $exitcode
221}
222
223# Checks an environment variable is not set or has length 0 OR if the
224# exit code is non-zero and prints "message"
225# NOTE: env-var is the variable name without a '$'
226# err_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100227function err_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600228 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100229 local xtrace
230 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600231 set +o xtrace
232 local line=$1; shift
233 local evar=$1; shift
234 if ! is_set $evar || [ $exitcode != 0 ]; then
235 err $line "$*"
236 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500237 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600238 return $exitcode
239}
240
241# Exit after outputting a message about the distribution not being supported.
242# exit_distro_not_supported [optional-string-telling-what-is-missing]
243function exit_distro_not_supported {
244 if [[ -z "$DISTRO" ]]; then
245 GetDistro
246 fi
247
248 if [ $# -gt 0 ]; then
249 die $LINENO "Support for $DISTRO is incomplete: no support for $@"
250 else
251 die $LINENO "Support for $DISTRO is incomplete."
252 fi
253}
254
255# Test if the named environment variable is set and not zero length
256# is_set env-var
Ian Wienandaee18c72014-02-21 15:35:08 +1100257function is_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600258 local var=\$"$1"
259 eval "[ -n \"$var\" ]" # For ex.: sh -c "[ -n \"$var\" ]" would be better, but several exercises depends on this
260}
261
262# Prints line number and "message" in warning format
263# warn $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100264function warn {
Dean Troyerdff49a22014-01-30 15:37:40 -0600265 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100266 local xtrace
267 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600268 set +o xtrace
269 local msg="[WARNING] ${BASH_SOURCE[2]}:$1 $2"
Sean Daguee4af9292015-04-28 08:57:57 -0400270 echo $msg
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500271 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600272 return $exitcode
273}
274
275
276# Distro Functions
277# ================
278
279# Determine OS Vendor, Release and Update
280# Tested with OS/X, Ubuntu, RedHat, CentOS, Fedora
281# Returns results in global variables:
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500282# ``os_VENDOR`` - vendor name: ``Ubuntu``, ``Fedora``, etc
283# ``os_RELEASE`` - major release: ``14.04`` (Ubuntu), ``20`` (Fedora)
284# ``os_UPDATE`` - update: ex. the ``5`` in ``RHEL6.5``
285# ``os_PACKAGE`` - package type: ``deb`` or ``rpm``
286# ``os_CODENAME`` - vendor's codename for release: ``snow leopard``, ``trusty``
Sean Dague53753292014-12-04 19:38:15 -0500287os_VENDOR=""
288os_RELEASE=""
289os_UPDATE=""
290os_PACKAGE=""
291os_CODENAME=""
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500292
Dean Troyerdff49a22014-01-30 15:37:40 -0600293# GetOSVersion
Ian Wienandaee18c72014-02-21 15:35:08 +1100294function GetOSVersion {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500295
Dean Troyerdff49a22014-01-30 15:37:40 -0600296 # Figure out which vendor we are
297 if [[ -x "`which sw_vers 2>/dev/null`" ]]; then
298 # OS/X
299 os_VENDOR=`sw_vers -productName`
300 os_RELEASE=`sw_vers -productVersion`
301 os_UPDATE=${os_RELEASE##*.}
302 os_RELEASE=${os_RELEASE%.*}
303 os_PACKAGE=""
304 if [[ "$os_RELEASE" =~ "10.7" ]]; then
305 os_CODENAME="lion"
306 elif [[ "$os_RELEASE" =~ "10.6" ]]; then
307 os_CODENAME="snow leopard"
308 elif [[ "$os_RELEASE" =~ "10.5" ]]; then
309 os_CODENAME="leopard"
310 elif [[ "$os_RELEASE" =~ "10.4" ]]; then
311 os_CODENAME="tiger"
312 elif [[ "$os_RELEASE" =~ "10.3" ]]; then
313 os_CODENAME="panther"
314 else
315 os_CODENAME=""
316 fi
317 elif [[ -x $(which lsb_release 2>/dev/null) ]]; then
318 os_VENDOR=$(lsb_release -i -s)
319 os_RELEASE=$(lsb_release -r -s)
320 os_UPDATE=""
321 os_PACKAGE="rpm"
322 if [[ "Debian,Ubuntu,LinuxMint" =~ $os_VENDOR ]]; then
323 os_PACKAGE="deb"
324 elif [[ "SUSE LINUX" =~ $os_VENDOR ]]; then
325 lsb_release -d -s | grep -q openSUSE
326 if [[ $? -eq 0 ]]; then
327 os_VENDOR="openSUSE"
328 fi
329 elif [[ $os_VENDOR == "openSUSE project" ]]; then
330 os_VENDOR="openSUSE"
331 elif [[ $os_VENDOR =~ Red.*Hat ]]; then
332 os_VENDOR="Red Hat"
333 fi
334 os_CODENAME=$(lsb_release -c -s)
335 elif [[ -r /etc/redhat-release ]]; then
336 # Red Hat Enterprise Linux Server release 5.5 (Tikanga)
337 # Red Hat Enterprise Linux Server release 7.0 Beta (Maipo)
338 # CentOS release 5.5 (Final)
339 # CentOS Linux release 6.0 (Final)
340 # Fedora release 16 (Verne)
341 # XenServer release 6.2.0-70446c (xenenterprise)
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700342 # Oracle Linux release 7
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300343 # CloudLinux release 7.1
Dean Troyerdff49a22014-01-30 15:37:40 -0600344 os_CODENAME=""
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300345 for r in "Red Hat" CentOS Fedora XenServer CloudLinux; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600346 os_VENDOR=$r
347 if [[ -n "`grep \"$r\" /etc/redhat-release`" ]]; then
348 ver=`sed -e 's/^.* \([0-9].*\) (\(.*\)).*$/\1\|\2/' /etc/redhat-release`
349 os_CODENAME=${ver#*|}
350 os_RELEASE=${ver%|*}
351 os_UPDATE=${os_RELEASE##*.}
352 os_RELEASE=${os_RELEASE%.*}
353 break
354 fi
355 os_VENDOR=""
356 done
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700357 if [ "$os_VENDOR" = "Red Hat" ] && [[ -r /etc/oracle-release ]]; then
358 os_VENDOR=OracleLinux
359 fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600360 os_PACKAGE="rpm"
361 elif [[ -r /etc/SuSE-release ]]; then
362 for r in openSUSE "SUSE Linux"; do
363 if [[ "$r" = "SUSE Linux" ]]; then
364 os_VENDOR="SUSE LINUX"
365 else
366 os_VENDOR=$r
367 fi
368
369 if [[ -n "`grep \"$r\" /etc/SuSE-release`" ]]; then
370 os_CODENAME=`grep "CODENAME = " /etc/SuSE-release | sed 's:.* = ::g'`
371 os_RELEASE=`grep "VERSION = " /etc/SuSE-release | sed 's:.* = ::g'`
372 os_UPDATE=`grep "PATCHLEVEL = " /etc/SuSE-release | sed 's:.* = ::g'`
373 break
374 fi
375 os_VENDOR=""
376 done
377 os_PACKAGE="rpm"
378 # If lsb_release is not installed, we should be able to detect Debian OS
379 elif [[ -f /etc/debian_version ]] && [[ $(cat /proc/version) =~ "Debian" ]]; then
380 os_VENDOR="Debian"
381 os_PACKAGE="deb"
382 os_CODENAME=$(awk '/VERSION=/' /etc/os-release | sed 's/VERSION=//' | sed -r 's/\"|\(|\)//g' | awk '{print $2}')
383 os_RELEASE=$(awk '/VERSION_ID=/' /etc/os-release | sed 's/VERSION_ID=//' | sed 's/\"//g')
384 fi
385 export os_VENDOR os_RELEASE os_UPDATE os_PACKAGE os_CODENAME
386}
387
388# Translate the OS version values into common nomenclature
389# Sets global ``DISTRO`` from the ``os_*`` values
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500390declare DISTRO
391
Ian Wienandaee18c72014-02-21 15:35:08 +1100392function GetDistro {
Dean Troyerdff49a22014-01-30 15:37:40 -0600393 GetOSVersion
394 if [[ "$os_VENDOR" =~ (Ubuntu) || "$os_VENDOR" =~ (Debian) ]]; then
395 # 'Everyone' refers to Ubuntu / Debian releases by the code name adjective
396 DISTRO=$os_CODENAME
397 elif [[ "$os_VENDOR" =~ (Fedora) ]]; then
398 # For Fedora, just use 'f' and the release
399 DISTRO="f$os_RELEASE"
400 elif [[ "$os_VENDOR" =~ (openSUSE) ]]; then
401 DISTRO="opensuse-$os_RELEASE"
402 elif [[ "$os_VENDOR" =~ (SUSE LINUX) ]]; then
403 # For SLE, also use the service pack
404 if [[ -z "$os_UPDATE" ]]; then
405 DISTRO="sle${os_RELEASE}"
406 else
407 DISTRO="sle${os_RELEASE}sp${os_UPDATE}"
408 fi
anju Tiwari6c639c92014-07-15 18:11:54 +0530409 elif [[ "$os_VENDOR" =~ (Red Hat) || \
410 "$os_VENDOR" =~ (CentOS) || \
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700411 "$os_VENDOR" =~ (OracleLinux) ]]; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600412 # Drop the . release as we assume it's compatible
413 DISTRO="rhel${os_RELEASE::1}"
414 elif [[ "$os_VENDOR" =~ (XenServer) ]]; then
415 DISTRO="xs$os_RELEASE"
416 else
417 # Catch-all for now is Vendor + Release + Update
418 DISTRO="$os_VENDOR-$os_RELEASE.$os_UPDATE"
419 fi
420 export DISTRO
421}
422
423# Utility function for checking machine architecture
424# is_arch arch-type
425function is_arch {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500426 [[ "$(uname -m)" == "$1" ]]
Dean Troyerdff49a22014-01-30 15:37:40 -0600427}
428
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700429# Determine if current distribution is an Oracle distribution
430# is_oraclelinux
431function is_oraclelinux {
432 if [[ -z "$os_VENDOR" ]]; then
433 GetOSVersion
434 fi
435
436 [ "$os_VENDOR" = "OracleLinux" ]
437}
438
439
Dean Troyerdff49a22014-01-30 15:37:40 -0600440# Determine if current distribution is a Fedora-based distribution
441# (Fedora, RHEL, CentOS, etc).
442# is_fedora
443function is_fedora {
444 if [[ -z "$os_VENDOR" ]]; then
445 GetOSVersion
446 fi
447
anju Tiwari6c639c92014-07-15 18:11:54 +0530448 [ "$os_VENDOR" = "Fedora" ] || [ "$os_VENDOR" = "Red Hat" ] || \
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300449 [ "$os_VENDOR" = "CentOS" ] || [ "$os_VENDOR" = "OracleLinux" ] || \
450 [ "$os_VENDOR" = "CloudLinux" ]
Dean Troyerdff49a22014-01-30 15:37:40 -0600451}
452
453
454# Determine if current distribution is a SUSE-based distribution
455# (openSUSE, SLE).
456# is_suse
457function is_suse {
458 if [[ -z "$os_VENDOR" ]]; then
459 GetOSVersion
460 fi
461
462 [ "$os_VENDOR" = "openSUSE" ] || [ "$os_VENDOR" = "SUSE LINUX" ]
463}
464
465
466# Determine if current distribution is an Ubuntu-based distribution
467# It will also detect non-Ubuntu but Debian-based distros
468# is_ubuntu
469function is_ubuntu {
470 if [[ -z "$os_PACKAGE" ]]; then
471 GetOSVersion
472 fi
473 [ "$os_PACKAGE" = "deb" ]
474}
475
476
477# Git Functions
478# =============
479
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600480# Returns openstack release name for a given branch name
481# ``get_release_name_from_branch branch-name``
Ian Wienandaee18c72014-02-21 15:35:08 +1100482function get_release_name_from_branch {
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600483 local branch=$1
Adam Gandelman8f385722014-10-14 15:50:18 -0700484 if [[ $branch =~ "stable/" || $branch =~ "proposed/" ]]; then
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600485 echo ${branch#*/}
486 else
487 echo "master"
488 fi
489}
490
Dean Troyerdff49a22014-01-30 15:37:40 -0600491# git clone only if directory doesn't exist already. Since ``DEST`` might not
492# be owned by the installation user, we create the directory and change the
493# ownership to the proper user.
Dean Troyer50cda692014-07-25 11:57:20 -0500494# Set global ``RECLONE=yes`` to simulate a clone when dest-dir exists
495# Set global ``ERROR_ON_CLONE=True`` to abort execution with an error if the git repo
Dean Troyerdff49a22014-01-30 15:37:40 -0600496# does not exist (default is False, meaning the repo will be cloned).
Sean Dague53753292014-12-04 19:38:15 -0500497# Uses globals ``ERROR_ON_CLONE``, ``OFFLINE``, ``RECLONE``
Dean Troyerdff49a22014-01-30 15:37:40 -0600498# git_clone remote dest-dir branch
499function git_clone {
Dean Troyer50cda692014-07-25 11:57:20 -0500500 local git_remote=$1
501 local git_dest=$2
502 local git_ref=$3
Ian Wienandada886d2015-10-07 14:06:26 +1100503 local orig_dir
504 orig_dir=$(pwd)
Jamie Lennox51f0de52014-10-20 16:32:34 +0200505 local git_clone_flags=""
Dean Troyer50cda692014-07-25 11:57:20 -0500506
Sean Dague53753292014-12-04 19:38:15 -0500507 RECLONE=$(trueorfalse False RECLONE)
Kevin Benton59d52f32015-01-17 11:29:12 -0800508 if [[ "${GIT_DEPTH}" -gt 0 ]]; then
Jamie Lennox51f0de52014-10-20 16:32:34 +0200509 git_clone_flags="$git_clone_flags --depth $GIT_DEPTH"
510 fi
511
Dean Troyerdff49a22014-01-30 15:37:40 -0600512 if [[ "$OFFLINE" = "True" ]]; then
513 echo "Running in offline mode, clones already exist"
514 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500515 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600516 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400517 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600518 return
519 fi
520
Dean Troyer50cda692014-07-25 11:57:20 -0500521 if echo $git_ref | egrep -q "^refs"; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600522 # If our branch name is a gerrit style refs/changes/...
Dean Troyer50cda692014-07-25 11:57:20 -0500523 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700524 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
525 echo "The $git_dest project was not found; if this is a gate job, add"
526 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600527 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700528 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200529 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600530 fi
Dean Troyer50cda692014-07-25 11:57:20 -0500531 cd $git_dest
532 git_timed fetch $git_remote $git_ref && git checkout FETCH_HEAD
Dean Troyerdff49a22014-01-30 15:37:40 -0600533 else
534 # do a full clone only if the directory doesn't exist
Dean Troyer50cda692014-07-25 11:57:20 -0500535 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700536 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
537 echo "The $git_dest project was not found; if this is a gate job, add"
538 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600539 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700540 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200541 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyer50cda692014-07-25 11:57:20 -0500542 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600543 # This checkout syntax works for both branches and tags
Dean Troyer50cda692014-07-25 11:57:20 -0500544 git checkout $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600545 elif [[ "$RECLONE" = "True" ]]; then
546 # if it does exist then simulate what clone does if asked to RECLONE
Dean Troyer50cda692014-07-25 11:57:20 -0500547 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600548 # set the url to pull from and fetch
Dean Troyer50cda692014-07-25 11:57:20 -0500549 git remote set-url origin $git_remote
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100550 git_timed fetch origin
Dean Troyerdff49a22014-01-30 15:37:40 -0600551 # remove the existing ignored files (like pyc) as they cause breakage
552 # (due to the py files having older timestamps than our pyc, so python
553 # thinks the pyc files are correct using them)
Dean Troyer50cda692014-07-25 11:57:20 -0500554 find $git_dest -name '*.pyc' -delete
Dean Troyerdff49a22014-01-30 15:37:40 -0600555
Dean Troyer50cda692014-07-25 11:57:20 -0500556 # handle git_ref accordingly to type (tag, branch)
557 if [[ -n "`git show-ref refs/tags/$git_ref`" ]]; then
558 git_update_tag $git_ref
559 elif [[ -n "`git show-ref refs/heads/$git_ref`" ]]; then
560 git_update_branch $git_ref
561 elif [[ -n "`git show-ref refs/remotes/origin/$git_ref`" ]]; then
562 git_update_remote_branch $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600563 else
Dean Troyer50cda692014-07-25 11:57:20 -0500564 die $LINENO "$git_ref is neither branch nor tag"
Dean Troyerdff49a22014-01-30 15:37:40 -0600565 fi
566
567 fi
568 fi
569
570 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500571 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600572 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400573 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600574}
575
Sean Daguecc524062014-10-01 09:06:43 -0400576# A variation on git clone that lets us specify a project by it's
577# actual name, like oslo.config. This is exceptionally useful in the
578# library installation case
579function git_clone_by_name {
580 local name=$1
581 local repo=${GITREPO[$name]}
582 local dir=${GITDIR[$name]}
583 local branch=${GITBRANCH[$name]}
584 git_clone $repo $dir $branch
585}
586
587
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100588# git can sometimes get itself infinitely stuck with transient network
589# errors or other issues with the remote end. This wraps git in a
590# timeout/retry loop and is intended to watch over non-local git
591# processes that might hang. GIT_TIMEOUT, if set, is passed directly
592# to timeout(1); otherwise the default value of 0 maintains the status
593# quo of waiting forever.
594# usage: git_timed <git-command>
Ian Wienandaee18c72014-02-21 15:35:08 +1100595function git_timed {
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100596 local count=0
597 local timeout=0
598
599 if [[ -n "${GIT_TIMEOUT}" ]]; then
600 timeout=${GIT_TIMEOUT}
601 fi
602
603 until timeout -s SIGINT ${timeout} git "$@"; do
604 # 124 is timeout(1)'s special return code when it reached the
605 # timeout; otherwise assume fatal failure
606 if [[ $? -ne 124 ]]; then
607 die $LINENO "git call failed: [git $@]"
608 fi
609
610 count=$(($count + 1))
Sean Daguee4af9292015-04-28 08:57:57 -0400611 warn $LINENO "timeout ${count} for git call: [git $@]"
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100612 if [ $count -eq 3 ]; then
613 die $LINENO "Maximum of 3 git retries reached"
614 fi
615 sleep 5
616 done
617}
618
Dean Troyerdff49a22014-01-30 15:37:40 -0600619# git update using reference as a branch.
620# git_update_branch ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100621function git_update_branch {
Dean Troyer50cda692014-07-25 11:57:20 -0500622 local git_branch=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600623
Dean Troyer50cda692014-07-25 11:57:20 -0500624 git checkout -f origin/$git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600625 # a local branch might not exist
Dean Troyer50cda692014-07-25 11:57:20 -0500626 git branch -D $git_branch || true
627 git checkout -b $git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600628}
629
630# git update using reference as a branch.
631# git_update_remote_branch ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100632function git_update_remote_branch {
Dean Troyer50cda692014-07-25 11:57:20 -0500633 local git_branch=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600634
Dean Troyer50cda692014-07-25 11:57:20 -0500635 git checkout -b $git_branch -t origin/$git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600636}
637
638# git update using reference as a tag. Be careful editing source at that repo
639# as working copy will be in a detached mode
640# git_update_tag ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100641function git_update_tag {
Dean Troyer50cda692014-07-25 11:57:20 -0500642 local git_tag=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600643
Dean Troyer50cda692014-07-25 11:57:20 -0500644 git tag -d $git_tag
Dean Troyerdff49a22014-01-30 15:37:40 -0600645 # fetching given tag only
Dean Troyer50cda692014-07-25 11:57:20 -0500646 git_timed fetch origin tag $git_tag
647 git checkout -f $git_tag
Dean Troyerdff49a22014-01-30 15:37:40 -0600648}
649
650
651# OpenStack Functions
652# ===================
653
654# Get the default value for HOST_IP
655# get_default_host_ip fixed_range floating_range host_ip_iface host_ip
Ian Wienandaee18c72014-02-21 15:35:08 +1100656function get_default_host_ip {
Dean Troyerdff49a22014-01-30 15:37:40 -0600657 local fixed_range=$1
658 local floating_range=$2
659 local host_ip_iface=$3
660 local host_ip=$4
Brian Haley180f5eb2015-06-16 13:14:31 -0400661 local af=$5
Dean Troyerdff49a22014-01-30 15:37:40 -0600662
Dean Troyerdff49a22014-01-30 15:37:40 -0600663 # Search for an IP unless an explicit is set by ``HOST_IP`` environment variable
664 if [ -z "$host_ip" -o "$host_ip" == "dhcp" ]; then
665 host_ip=""
Andreas Scheuringa3430272015-03-09 16:55:32 +0100666 # Find the interface used for the default route
Brian Haley180f5eb2015-06-16 13:14:31 -0400667 host_ip_iface=${host_ip_iface:-$(ip -f $af route | awk '/default/ {print $5}' | head -1)}
Ian Wienandada886d2015-10-07 14:06:26 +1100668 local host_ips
669 host_ips=$(LC_ALL=C ip -f $af addr show ${host_ip_iface} | sed /temporary/d |awk /$af'/ {split($2,parts,"/"); print parts[1]}')
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500670 local ip
671 for ip in $host_ips; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600672 # Attempt to filter out IP addresses that are part of the fixed and
673 # floating range. Note that this method only works if the ``netaddr``
674 # python library is installed. If it is not installed, an error
675 # will be printed and the first IP from the interface will be used.
676 # If that is not correct set ``HOST_IP`` in ``localrc`` to the correct
677 # address.
Brian Haley180f5eb2015-06-16 13:14:31 -0400678 if [[ "$af" == "inet6" ]]; then
679 host_ip=$ip
680 break;
681 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500682 if ! (address_in_net $ip $fixed_range || address_in_net $ip $floating_range); then
683 host_ip=$ip
Dean Troyerdff49a22014-01-30 15:37:40 -0600684 break;
685 fi
686 done
687 fi
688 echo $host_ip
689}
690
Attila Fazekasf71b5002014-05-28 09:52:22 +0200691# Generates hex string from ``size`` byte of pseudo random data
692# generate_hex_string size
693function generate_hex_string {
694 local size=$1
695 hexdump -n "$size" -v -e '/1 "%02x"' /dev/urandom
696}
697
Dean Troyerdff49a22014-01-30 15:37:40 -0600698# Grab a numbered field from python prettytable output
699# Fields are numbered starting with 1
700# Reverse syntax is supported: -1 is the last field, -2 is second to last, etc.
701# get_field field-number
Ian Wienandaee18c72014-02-21 15:35:08 +1100702function get_field {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500703 local data field
Dean Troyerdff49a22014-01-30 15:37:40 -0600704 while read data; do
705 if [ "$1" -lt 0 ]; then
706 field="(\$(NF$1))"
707 else
708 field="\$$(($1 + 1))"
709 fi
710 echo "$data" | awk -F'[ \t]*\\|[ \t]*' "{print $field}"
711 done
712}
713
yuntongjinf26deea2015-02-28 10:50:34 +0800714# install default policy
715# copy over a default policy.json and policy.d for projects
716function install_default_policy {
717 local project=$1
Ian Wienandada886d2015-10-07 14:06:26 +1100718 local project_uc
719 project_uc=$(echo $1|tr a-z A-Z)
yuntongjinf26deea2015-02-28 10:50:34 +0800720 local conf_dir="${project_uc}_CONF_DIR"
721 # eval conf dir to get the variable
722 conf_dir="${!conf_dir}"
723 local project_dir="${project_uc}_DIR"
724 # eval project dir to get the variable
725 project_dir="${!project_dir}"
726 local sample_conf_dir="${project_dir}/etc/${project}"
727 local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
728
729 # first copy any policy.json
730 cp -p $sample_conf_dir/policy.json $conf_dir
731 # then optionally copy over policy.d
732 if [[ -d $sample_policy_dir ]]; then
733 cp -r $sample_policy_dir $conf_dir/policy.d
734 fi
735}
736
Dean Troyerdff49a22014-01-30 15:37:40 -0600737# Add a policy to a policy.json file
738# Do nothing if the policy already exists
739# ``policy_add policy_file policy_name policy_permissions``
Ian Wienandaee18c72014-02-21 15:35:08 +1100740function policy_add {
Dean Troyerdff49a22014-01-30 15:37:40 -0600741 local policy_file=$1
742 local policy_name=$2
743 local policy_perm=$3
744
745 if grep -q ${policy_name} ${policy_file}; then
746 echo "Policy ${policy_name} already exists in ${policy_file}"
747 return
748 fi
749
750 # Add a terminating comma to policy lines without one
751 # Remove the closing '}' and all lines following to the end-of-file
Ian Wienandada886d2015-10-07 14:06:26 +1100752 local tmpfile
753 tmpfile=$(mktemp)
Dean Troyerdff49a22014-01-30 15:37:40 -0600754 uniq ${policy_file} | sed -e '
755 s/]$/],/
756 /^[}]/,$d
757 ' > ${tmpfile}
758
759 # Append policy and closing brace
760 echo " \"${policy_name}\": ${policy_perm}" >>${tmpfile}
761 echo "}" >>${tmpfile}
762
763 mv ${tmpfile} ${policy_file}
764}
765
Alistair Coles24779f62014-10-15 18:57:59 +0100766# Gets or creates a domain
767# Usage: get_or_create_domain <name> <description>
768function get_or_create_domain {
Ian Wienand11d276c2015-07-02 09:34:34 +1000769 local domain_id
Alistair Coles24779f62014-10-15 18:57:59 +0100770 # Gets domain id
Ian Wienand11d276c2015-07-02 09:34:34 +1000771 domain_id=$(
Alistair Coles24779f62014-10-15 18:57:59 +0100772 # Gets domain id
Steve Martinelli050a0d52015-09-06 22:03:54 +0000773 openstack domain show $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100774 -f value -c id 2>/dev/null ||
775 # Creates new domain
Steve Martinelli050a0d52015-09-06 22:03:54 +0000776 openstack domain create $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100777 --description "$2" \
778 -f value -c id
779 )
780 echo $domain_id
781}
782
Steve Martinellib74e01c2014-12-18 01:35:35 -0500783# Gets or creates group
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000784# Usage: get_or_create_group <groupname> <domain> [<description>]
Steve Martinellib74e01c2014-12-18 01:35:35 -0500785function get_or_create_group {
Steve Martinellib74e01c2014-12-18 01:35:35 -0500786 local desc="${3:-}"
Ian Wienand11d276c2015-07-02 09:34:34 +1000787 local group_id
Steve Martinellib74e01c2014-12-18 01:35:35 -0500788 # Gets group id
Ian Wienand11d276c2015-07-02 09:34:34 +1000789 group_id=$(
Steve Martinellib74e01c2014-12-18 01:35:35 -0500790 # Creates new group with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000791 openstack group create $1 \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000792 --domain $2 --description "$desc" --or-show \
Steve Martinellib74e01c2014-12-18 01:35:35 -0500793 -f value -c id
794 )
795 echo $group_id
796}
797
Bartosz Górski0abde392014-02-28 14:15:19 +0100798# Gets or creates user
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000799# Usage: get_or_create_user <username> <password> <domain> [<email>]
Bartosz Górski0abde392014-02-28 14:15:19 +0100800function get_or_create_user {
Ian Wienand11d276c2015-07-02 09:34:34 +1000801 local user_id
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000802 if [[ ! -z "$4" ]]; then
803 local email="--email=$4"
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200804 else
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500805 local email=""
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200806 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100807 # Gets user id
Ian Wienand11d276c2015-07-02 09:34:34 +1000808 user_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500809 # Creates new user with --or-show
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000810 openstack user create \
Bartosz Górski0abde392014-02-28 14:15:19 +0100811 $1 \
812 --password "$2" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000813 --domain=$3 \
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500814 $email \
Steve Martinelli245daa22014-11-14 02:17:22 -0500815 --or-show \
Bartosz Górski0abde392014-02-28 14:15:19 +0100816 -f value -c id
817 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500818 echo $user_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100819}
820
821# Gets or creates project
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000822# Usage: get_or_create_project <name> <domain>
Bartosz Górski0abde392014-02-28 14:15:19 +0100823function get_or_create_project {
Ian Wienand11d276c2015-07-02 09:34:34 +1000824 local project_id
825 project_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500826 # Creates new project with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000827 openstack project create $1 \
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000828 --domain=$2 \
829 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100830 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500831 echo $project_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100832}
833
834# Gets or creates role
835# Usage: get_or_create_role <name>
836function get_or_create_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000837 local role_id
838 role_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500839 # Creates role with --or-show
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000840 openstack role create $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000841 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100842 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500843 echo $role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100844}
845
Jamie Lennox9b215db2015-02-10 18:19:57 +1100846# Gets or adds user role to project
847# Usage: get_or_add_user_project_role <role> <user> <project>
848function get_or_add_user_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000849 local user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100850 # Gets user role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000851 user_role_id=$(openstack role list \
Steve Martinelli5541a612015-01-19 15:58:49 -0500852 --user $2 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100853 --column "ID" \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000854 --project $3 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100855 --column "Name" \
856 | grep " $1 " | get_field 1)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500857 if [[ -z "$user_role_id" ]]; then
Roxana Gherle50821be2015-09-22 10:52:46 -0700858 # Adds role to user and get it
859 openstack role add $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100860 --user $2 \
Steve Martinelli050a0d52015-09-06 22:03:54 +0000861 --project $3
Roxana Gherle50821be2015-09-22 10:52:46 -0700862 user_role_id=$(openstack role list \
863 --user $2 \
Roxana Gherle50821be2015-09-22 10:52:46 -0700864 --column "ID" \
865 --project $3 \
866 --column "Name" \
867 | grep " $1 " | get_field 1)
Bartosz Górski0abde392014-02-28 14:15:19 +0100868 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500869 echo $user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100870}
871
Steve Martinelli4599fd12015-03-12 21:30:58 -0400872# Gets or adds group role to project
873# Usage: get_or_add_group_project_role <role> <group> <project>
874function get_or_add_group_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000875 local group_role_id
Steve Martinelli4599fd12015-03-12 21:30:58 -0400876 # Gets group role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000877 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400878 --group $2 \
879 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000880 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400881 if [[ -z "$group_role_id" ]]; then
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000882 # Adds role to group and get it
883 openstack role add $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000884 --group $2 \
885 --project $3
886 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400887 --group $2 \
888 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000889 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400890 fi
891 echo $group_role_id
892}
893
Bartosz Górski0abde392014-02-28 14:15:19 +0100894# Gets or creates service
895# Usage: get_or_create_service <name> <type> <description>
896function get_or_create_service {
Ian Wienand11d276c2015-07-02 09:34:34 +1000897 local service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100898 # Gets service id
Ian Wienand11d276c2015-07-02 09:34:34 +1000899 service_id=$(
Bartosz Górski0abde392014-02-28 14:15:19 +0100900 # Gets service id
Jamie Lennoxaedb8b92015-07-02 17:39:07 +1000901 openstack service show $2 -f value -c id 2>/dev/null ||
Bartosz Górski0abde392014-02-28 14:15:19 +0100902 # Creates new service if not exists
903 openstack service create \
Steve Martinelli789af5c2015-01-19 16:11:44 -0500904 $2 \
905 --name $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100906 --description="$3" \
907 -f value -c id
908 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500909 echo $service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100910}
911
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000912# Create an endpoint with a specific interface
913# Usage: _get_or_create_endpoint_with_interface <service> <interface> <url> <region>
914function _get_or_create_endpoint_with_interface {
Ian Wienand11d276c2015-07-02 09:34:34 +1000915 local endpoint_id
916 endpoint_id=$(openstack endpoint list \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000917 --service $1 \
918 --interface $2 \
919 --region $4 \
Daniel Gonzalez0ec80802015-10-30 14:25:41 +0100920 -c ID -f value)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500921 if [[ -z "$endpoint_id" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100922 # Creates new endpoint
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500923 endpoint_id=$(openstack endpoint create \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000924 $1 $2 $3 --region $4 -f value -c id)
Bartosz Górski0abde392014-02-28 14:15:19 +0100925 fi
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000926
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500927 echo $endpoint_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100928}
Dean Troyerdff49a22014-01-30 15:37:40 -0600929
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000930# Gets or creates endpoint
931# Usage: get_or_create_endpoint <service> <region> <publicurl> <adminurl> <internalurl>
932function get_or_create_endpoint {
933 # NOTE(jamielennnox): when converting to v3 endpoint creation we go from
934 # creating one endpoint with multiple urls to multiple endpoints each with
935 # a different interface. To maintain the existing function interface we
936 # create 3 endpoints and return the id of the public one. In reality
937 # returning the public id will not make a lot of difference as there are no
938 # scenarios currently that use the returned id. Ideally this behaviour
939 # should be pushed out to the service setups and let them create the
940 # endpoints they need.
Ian Wienandada886d2015-10-07 14:06:26 +1100941 local public_id
942 public_id=$(_get_or_create_endpoint_with_interface $1 public $3 $2)
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000943 _get_or_create_endpoint_with_interface $1 admin $4 $2
944 _get_or_create_endpoint_with_interface $1 internal $5 $2
945
946 # return the public id to indicate success, and this is the endpoint most likely wanted
947 echo $public_id
948}
949
950# Get a URL from the identity service
951# Usage: get_endpoint_url <service> <interface>
952function get_endpoint_url {
953 echo $(openstack endpoint list \
954 --service $1 --interface $2 \
955 --os-url $KEYSTONE_SERVICE_URI_V3 \
956 --os-identity-api-version=3 \
957 -c URL -f value)
958}
959
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500960
Dean Troyerdff49a22014-01-30 15:37:40 -0600961# Package Functions
962# =================
963
964# _get_package_dir
Ian Wienandaee18c72014-02-21 15:35:08 +1100965function _get_package_dir {
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800966 local base_dir=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600967 local pkg_dir
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800968
969 if [[ -z "$base_dir" ]]; then
970 base_dir=$FILES
971 fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600972 if is_ubuntu; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800973 pkg_dir=$base_dir/debs
Dean Troyerdff49a22014-01-30 15:37:40 -0600974 elif is_fedora; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800975 pkg_dir=$base_dir/rpms
Dean Troyerdff49a22014-01-30 15:37:40 -0600976 elif is_suse; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800977 pkg_dir=$base_dir/rpms-suse
Dean Troyerdff49a22014-01-30 15:37:40 -0600978 else
979 exit_distro_not_supported "list of packages"
980 fi
981 echo "$pkg_dir"
982}
983
984# Wrapper for ``apt-get`` to set cache and proxy environment variables
985# Uses globals ``OFFLINE``, ``*_proxy``
986# apt_get operation package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +1100987function apt_get {
Ian Wienand433a9b12015-10-07 13:29:31 +1100988 local xtrace
989 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -0500990 set +o xtrace
991
Dean Troyerdff49a22014-01-30 15:37:40 -0600992 [[ "$OFFLINE" = "True" || -z "$@" ]] && return
993 local sudo="sudo"
994 [[ "$(id -u)" = "0" ]] && sudo="env"
Sean Dague45917cc2014-02-24 16:09:14 -0500995
Sean Dague95c33d52015-10-07 11:05:59 -0400996 # time all the apt operations
997 time_start "apt-get"
998
Sean Dague45917cc2014-02-24 16:09:14 -0500999 $xtrace
Sean Dague53753292014-12-04 19:38:15 -05001000
Dean Troyerdff49a22014-01-30 15:37:40 -06001001 $sudo DEBIAN_FRONTEND=noninteractive \
Sean Dague53753292014-12-04 19:38:15 -05001002 http_proxy=${http_proxy:-} https_proxy=${https_proxy:-} \
1003 no_proxy=${no_proxy:-} \
Dean Troyerdff49a22014-01-30 15:37:40 -06001004 apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@"
Sean Dague95c33d52015-10-07 11:05:59 -04001005
1006 # stop the clock
1007 time_stop "apt-get"
Dean Troyerdff49a22014-01-30 15:37:40 -06001008}
1009
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001010function _parse_package_files {
1011 local files_to_parse=$@
Dean Troyerdff49a22014-01-30 15:37:40 -06001012
Dean Troyerdff49a22014-01-30 15:37:40 -06001013 if [[ -z "$DISTRO" ]]; then
1014 GetDistro
1015 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001016
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001017 for fname in ${files_to_parse}; do
Dean Troyerdff49a22014-01-30 15:37:40 -06001018 local OIFS line package distros distro
1019 [[ -e $fname ]] || continue
1020
1021 OIFS=$IFS
1022 IFS=$'\n'
1023 for line in $(<${fname}); do
1024 if [[ $line =~ "NOPRIME" ]]; then
1025 continue
1026 fi
1027
1028 # Assume we want this package
1029 package=${line%#*}
1030 inst_pkg=1
1031
1032 # Look for # dist:xxx in comment
1033 if [[ $line =~ (.*)#.*dist:([^ ]*) ]]; then
1034 # We are using BASH regexp matching feature.
1035 package=${BASH_REMATCH[1]}
1036 distros=${BASH_REMATCH[2]}
1037 # In bash ${VAR,,} will lowecase VAR
1038 # Look for a match in the distro list
1039 if [[ ! ${distros,,} =~ ${DISTRO,,} ]]; then
1040 # If no match then skip this package
1041 inst_pkg=0
1042 fi
1043 fi
1044
Dean Troyerdff49a22014-01-30 15:37:40 -06001045 if [[ $inst_pkg = 1 ]]; then
1046 echo $package
1047 fi
1048 done
1049 IFS=$OIFS
1050 done
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001051}
1052
1053# get_packages() collects a list of package names of any type from the
1054# prerequisite files in ``files/{debs|rpms}``. The list is intended
1055# to be passed to a package installer such as apt or yum.
1056#
1057# Only packages required for the services in 1st argument will be
1058# included. Two bits of metadata are recognized in the prerequisite files:
1059#
1060# - ``# NOPRIME`` defers installation to be performed later in `stack.sh`
1061# - ``# dist:DISTRO`` or ``dist:DISTRO1,DISTRO2`` limits the selection
1062# of the package to the distros listed. The distro names are case insensitive.
1063function get_packages {
Ian Wienand433a9b12015-10-07 13:29:31 +11001064 local xtrace
1065 xtrace=$(set +o | grep xtrace)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001066 set +o xtrace
1067 local services=$@
Ian Wienandada886d2015-10-07 14:06:26 +11001068 local package_dir
1069 package_dir=$(_get_package_dir)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001070 local file_to_parse=""
1071 local service=""
1072
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001073 if [[ -z "$package_dir" ]]; then
1074 echo "No package directory supplied"
1075 return 1
1076 fi
1077 for service in ${services//,/ }; do
1078 # Allow individual services to specify dependencies
1079 if [[ -e ${package_dir}/${service} ]]; then
1080 file_to_parse="${file_to_parse} ${package_dir}/${service}"
1081 fi
1082 # NOTE(sdague) n-api needs glance for now because that's where
1083 # glance client is
1084 if [[ $service == n-api ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001085 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001086 file_to_parse="${file_to_parse} ${package_dir}/nova"
1087 fi
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001088 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001089 file_to_parse="${file_to_parse} ${package_dir}/glance"
1090 fi
1091 elif [[ $service == c-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001092 if [[ ! $file_to_parse =~ $package_dir/cinder ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001093 file_to_parse="${file_to_parse} ${package_dir}/cinder"
1094 fi
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001095 elif [[ $service == s-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001096 if [[ ! $file_to_parse =~ $package_dir/swift ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001097 file_to_parse="${file_to_parse} ${package_dir}/swift"
1098 fi
1099 elif [[ $service == n-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001100 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001101 file_to_parse="${file_to_parse} ${package_dir}/nova"
1102 fi
1103 elif [[ $service == g-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001104 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001105 file_to_parse="${file_to_parse} ${package_dir}/glance"
1106 fi
1107 elif [[ $service == key* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001108 if [[ ! $file_to_parse =~ $package_dir/keystone ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001109 file_to_parse="${file_to_parse} ${package_dir}/keystone"
1110 fi
1111 elif [[ $service == q-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001112 if [[ ! $file_to_parse =~ $package_dir/neutron ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001113 file_to_parse="${file_to_parse} ${package_dir}/neutron"
1114 fi
1115 elif [[ $service == ir-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001116 if [[ ! $file_to_parse =~ $package_dir/ironic ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001117 file_to_parse="${file_to_parse} ${package_dir}/ironic"
1118 fi
1119 fi
1120 done
1121 echo "$(_parse_package_files $file_to_parse)"
1122 $xtrace
1123}
1124
1125# get_plugin_packages() collects a list of package names of any type from a
1126# plugin's prerequisite files in ``$PLUGIN/devstack/files/{debs|rpms}``. The
1127# list is intended to be passed to a package installer such as apt or yum.
1128#
1129# Only packages required for enabled and collected plugins will included.
1130#
Dean Troyerdc97cb72015-03-28 08:20:50 -05001131# The same metadata used in the main DevStack prerequisite files may be used
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001132# in these prerequisite files, see get_packages() for more info.
1133function get_plugin_packages {
Ian Wienand433a9b12015-10-07 13:29:31 +11001134 local xtrace
1135 xtrace=$(set +o | grep xtrace)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001136 set +o xtrace
1137 local files_to_parse=""
1138 local package_dir=""
1139 for plugin in ${DEVSTACK_PLUGINS//,/ }; do
1140 local package_dir="$(_get_package_dir ${GITDIR[$plugin]}/devstack/files)"
1141 files_to_parse+="$package_dir/$plugin"
1142 done
1143 echo "$(_parse_package_files $files_to_parse)"
Sean Dague45917cc2014-02-24 16:09:14 -05001144 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001145}
1146
1147# Distro-agnostic package installer
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001148# Uses globals ``NO_UPDATE_REPOS``, ``REPOS_UPDATED``, ``RETRY_UPDATE``
Dean Troyerdff49a22014-01-30 15:37:40 -06001149# install_package package [package ...]
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001150function update_package_repo {
Sean Dague53753292014-12-04 19:38:15 -05001151 NO_UPDATE_REPOS=${NO_UPDATE_REPOS:-False}
1152 REPOS_UPDATED=${REPOS_UPDATED:-False}
1153 RETRY_UPDATE=${RETRY_UPDATE:-False}
1154
Paul Linchpiner9e179742014-07-13 22:23:00 -07001155 if [[ "$NO_UPDATE_REPOS" = "True" ]]; then
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001156 return 0
1157 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001158
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001159 if is_ubuntu; then
Ian Wienand433a9b12015-10-07 13:29:31 +11001160 local xtrace
1161 xtrace=$(set +o | grep xtrace)
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001162 set +o xtrace
1163 if [[ "$REPOS_UPDATED" != "True" || "$RETRY_UPDATE" = "True" ]]; then
1164 # if there are transient errors pulling the updates, that's fine.
1165 # It may be secondary repositories that we don't really care about.
1166 apt_get update || /bin/true
1167 REPOS_UPDATED=True
1168 fi
Sean Dague45917cc2014-02-24 16:09:14 -05001169 $xtrace
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001170 fi
1171}
1172
1173function real_install_package {
1174 if is_ubuntu; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001175 apt_get install "$@"
1176 elif is_fedora; then
1177 yum_install "$@"
1178 elif is_suse; then
1179 zypper_install "$@"
1180 else
1181 exit_distro_not_supported "installing packages"
1182 fi
1183}
1184
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001185# Distro-agnostic package installer
1186# install_package package [package ...]
1187function install_package {
1188 update_package_repo
1189 real_install_package $@ || RETRY_UPDATE=True update_package_repo && real_install_package $@
1190}
1191
Dean Troyerdff49a22014-01-30 15:37:40 -06001192# Distro-agnostic function to tell if a package is installed
1193# is_package_installed package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001194function is_package_installed {
Dean Troyerdff49a22014-01-30 15:37:40 -06001195 if [[ -z "$@" ]]; then
1196 return 1
1197 fi
1198
1199 if [[ -z "$os_PACKAGE" ]]; then
1200 GetOSVersion
1201 fi
1202
1203 if [[ "$os_PACKAGE" = "deb" ]]; then
1204 dpkg -s "$@" > /dev/null 2> /dev/null
1205 elif [[ "$os_PACKAGE" = "rpm" ]]; then
1206 rpm --quiet -q "$@"
1207 else
1208 exit_distro_not_supported "finding if a package is installed"
1209 fi
1210}
1211
1212# Distro-agnostic package uninstaller
1213# uninstall_package package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001214function uninstall_package {
Dean Troyerdff49a22014-01-30 15:37:40 -06001215 if is_ubuntu; then
1216 apt_get purge "$@"
1217 elif is_fedora; then
Ian Wienand36298ee2015-02-04 10:29:31 +11001218 sudo ${YUM:-yum} remove -y "$@" ||:
Dean Troyerdff49a22014-01-30 15:37:40 -06001219 elif is_suse; then
1220 sudo zypper rm "$@"
1221 else
1222 exit_distro_not_supported "uninstalling packages"
1223 fi
1224}
1225
1226# Wrapper for ``yum`` to set proxy environment variables
Daniel P. Berrange63d25d92014-12-09 15:21:22 +00001227# Uses globals ``OFFLINE``, ``*_proxy``, ``YUM``
Dean Troyerdff49a22014-01-30 15:37:40 -06001228# yum_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001229function yum_install {
Dean Troyerdff49a22014-01-30 15:37:40 -06001230 [[ "$OFFLINE" = "True" ]] && return
1231 local sudo="sudo"
1232 [[ "$(id -u)" = "0" ]] && sudo="env"
Ian Wienandb27f16d2014-02-28 14:29:02 +11001233
1234 # The manual check for missing packages is because yum -y assumes
1235 # missing packages are OK. See
1236 # https://bugzilla.redhat.com/show_bug.cgi?id=965567
Ian Wienandfdf00f22015-03-13 11:50:02 +11001237 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}" \
1238 no_proxy="${no_proxy:-}" \
Ian Wienand36298ee2015-02-04 10:29:31 +11001239 ${YUM:-yum} install -y "$@" 2>&1 | \
Ian Wienandb27f16d2014-02-28 14:29:02 +11001240 awk '
1241 BEGIN { fail=0 }
1242 /No package/ { fail=1 }
1243 { print }
1244 END { exit fail }' || \
1245 die $LINENO "Missing packages detected"
1246
1247 # also ensure we catch a yum failure
1248 if [[ ${PIPESTATUS[0]} != 0 ]]; then
Ian Wienand36298ee2015-02-04 10:29:31 +11001249 die $LINENO "${YUM:-yum} install failure"
Ian Wienandb27f16d2014-02-28 14:29:02 +11001250 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001251}
1252
1253# zypper wrapper to set arguments correctly
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001254# Uses globals ``OFFLINE``, ``*_proxy``
Dean Troyerdff49a22014-01-30 15:37:40 -06001255# zypper_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001256function zypper_install {
Dean Troyerdff49a22014-01-30 15:37:40 -06001257 [[ "$OFFLINE" = "True" ]] && return
1258 local sudo="sudo"
1259 [[ "$(id -u)" = "0" ]] && sudo="env"
Ian Wienandfdf00f22015-03-13 11:50:02 +11001260 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}" \
1261 no_proxy="${no_proxy:-}" \
Dean Troyerdff49a22014-01-30 15:37:40 -06001262 zypper --non-interactive install --auto-agree-with-licenses "$@"
1263}
1264
1265
1266# Process Functions
1267# =================
1268
1269# _run_process() is designed to be backgrounded by run_process() to simulate a
1270# fork. It includes the dirty work of closing extra filehandles and preparing log
1271# files to produce the same logs as screen_it(). The log filename is derived
Dean Troyerdde41d02014-12-09 17:47:57 -06001272# from the service name.
1273# Uses globals ``CURRENT_LOG_TIME``, ``LOGDIR``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001274# If an optional group is provided sg will be used to set the group of
1275# the command.
1276# _run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001277function _run_process {
Sean Dague6e137ab2015-04-29 08:22:24 -04001278 # disable tracing through the exec redirects, it's just confusing in the logs.
1279 xtrace=$(set +o | grep xtrace)
1280 set +o xtrace
1281
Dean Troyerdff49a22014-01-30 15:37:40 -06001282 local service=$1
1283 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001284 local group=$3
Dean Troyerdff49a22014-01-30 15:37:40 -06001285
1286 # Undo logging redirections and close the extra descriptors
1287 exec 1>&3
1288 exec 2>&3
1289 exec 3>&-
1290 exec 6>&-
1291
Dean Troyerdde41d02014-12-09 17:47:57 -06001292 local real_logfile="${LOGDIR}/${service}.log.${CURRENT_LOG_TIME}"
1293 if [[ -n ${LOGDIR} ]]; then
1294 exec 1>&"$real_logfile" 2>&1
1295 ln -sf "$real_logfile" ${LOGDIR}/${service}.log
1296 if [[ -n ${SCREEN_LOGDIR} ]]; then
1297 # Drop the backward-compat symlink
1298 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${service}.log
1299 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001300
1301 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1302 export PYTHONUNBUFFERED=1
1303 fi
1304
Sean Dague6e137ab2015-04-29 08:22:24 -04001305 # reenable xtrace before we do *real* work
1306 $xtrace
1307
Dean Troyer3159a822014-08-27 14:13:58 -05001308 # Run under ``setsid`` to force the process to become a session and group leader.
1309 # The pid saved can be used with pkill -g to get the entire process group.
Chris Dent2f27a0e2014-09-09 13:46:02 +01001310 if [[ -n "$group" ]]; then
1311 setsid sg $group "$command" & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1312 else
1313 setsid $command & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1314 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001315
1316 # Just silently exit this process
1317 exit 0
Dean Troyerdff49a22014-01-30 15:37:40 -06001318}
1319
1320# Helper to remove the ``*.failure`` files under ``$SERVICE_DIR/$SCREEN_NAME``.
1321# This is used for ``service_check`` when all the ``screen_it`` are called finished
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001322# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001323# init_service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001324function init_service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001325 SCREEN_NAME=${SCREEN_NAME:-stack}
1326 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1327
1328 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1329 mkdir -p "$SERVICE_DIR/$SCREEN_NAME"
1330 fi
1331
1332 rm -f "$SERVICE_DIR/$SCREEN_NAME"/*.failure
1333}
1334
1335# Find out if a process exists by partial name.
1336# is_running name
Ian Wienandaee18c72014-02-21 15:35:08 +11001337function is_running {
Dean Troyerdff49a22014-01-30 15:37:40 -06001338 local name=$1
1339 ps auxw | grep -v grep | grep ${name} > /dev/null
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001340 local exitcode=$?
Dean Troyerdff49a22014-01-30 15:37:40 -06001341 # some times I really hate bash reverse binary logic
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001342 return $exitcode
Dean Troyerdff49a22014-01-30 15:37:40 -06001343}
1344
Dean Troyer3159a822014-08-27 14:13:58 -05001345# Run a single service under screen or directly
1346# If the command includes shell metachatacters (;<>*) it must be run using a shell
Chris Dent2f27a0e2014-09-09 13:46:02 +01001347# If an optional group is provided sg will be used to run the
1348# command as that group.
1349# run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001350function run_process {
Dean Troyerdff49a22014-01-30 15:37:40 -06001351 local service=$1
1352 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001353 local group=$3
Dean Troyerdff49a22014-01-30 15:37:40 -06001354
Dean Troyer3159a822014-08-27 14:13:58 -05001355 if is_service_enabled $service; then
1356 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001357 screen_process "$service" "$command" "$group"
Dean Troyer3159a822014-08-27 14:13:58 -05001358 else
1359 # Spawn directly without screen
Chris Dent2f27a0e2014-09-09 13:46:02 +01001360 _run_process "$service" "$command" "$group" &
Dean Troyer3159a822014-08-27 14:13:58 -05001361 fi
1362 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001363}
1364
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001365# Helper to launch a process in a named screen
Dean Troyerdde41d02014-12-09 17:47:57 -06001366# Uses globals ``CURRENT_LOG_TIME``, ```LOGDIR``, ``SCREEN_LOGDIR``, `SCREEN_NAME``,
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001367# ``SERVICE_DIR``, ``USE_SCREEN``
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001368# screen_process name "command-line" [group]
Chris Dent2f27a0e2014-09-09 13:46:02 +01001369# Run a command in a shell in a screen window, if an optional group
1370# is provided, use sg to set the group of the command.
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001371function screen_process {
1372 local name=$1
Dean Troyer3159a822014-08-27 14:13:58 -05001373 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001374 local group=$3
Dean Troyer3159a822014-08-27 14:13:58 -05001375
Sean Dagueea22a4f2014-06-27 15:21:41 -04001376 SCREEN_NAME=${SCREEN_NAME:-stack}
1377 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001378 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyerdff49a22014-01-30 15:37:40 -06001379
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001380 screen -S $SCREEN_NAME -X screen -t $name
Dean Troyerdff49a22014-01-30 15:37:40 -06001381
Dean Troyerdde41d02014-12-09 17:47:57 -06001382 local real_logfile="${LOGDIR}/${name}.log.${CURRENT_LOG_TIME}"
1383 echo "LOGDIR: $LOGDIR"
1384 echo "SCREEN_LOGDIR: $SCREEN_LOGDIR"
1385 echo "log: $real_logfile"
1386 if [[ -n ${LOGDIR} ]]; then
1387 screen -S $SCREEN_NAME -p $name -X logfile "$real_logfile"
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001388 screen -S $SCREEN_NAME -p $name -X log on
Dean Troyerdde41d02014-12-09 17:47:57 -06001389 ln -sf "$real_logfile" ${LOGDIR}/${name}.log
1390 if [[ -n ${SCREEN_LOGDIR} ]]; then
1391 # Drop the backward-compat symlink
1392 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${1}.log
1393 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001394 fi
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001395
1396 # sleep to allow bash to be ready to be send the command - we are
1397 # creating a new window in screen and then sends characters, so if
Sean Dague4d7ee092015-04-07 10:40:49 -04001398 # bash isn't running by the time we send the command, nothing
1399 # happens. This sleep was added originally to handle gate runs
1400 # where we needed this to be at least 3 seconds to pass
1401 # consistently on slow clouds. Now this is configurable so that we
1402 # can determine a reasonable value for the local case which should
1403 # be much smaller.
1404 sleep ${SCREEN_SLEEP:-3}
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001405
1406 NL=`echo -ne '\015'`
1407 # This fun command does the following:
1408 # - the passed server command is backgrounded
1409 # - the pid of the background process is saved in the usual place
1410 # - the server process is brought back to the foreground
1411 # - if the server process exits prematurely the fg command errors
1412 # and a message is written to stdout and the process failure file
1413 #
1414 # The pid saved can be used in stop_process() as a process group
1415 # id to kill off all child processes
1416 if [[ -n "$group" ]]; then
1417 command="sg $group '$command'"
1418 fi
Ian Wienandb28b2702015-04-16 08:43:43 +10001419
1420 # Append the process to the screen rc file
1421 screen_rc "$name" "$command"
1422
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001423 screen -S $SCREEN_NAME -p $name -X stuff "$command & echo \$! >$SERVICE_DIR/$SCREEN_NAME/${name}.pid; fg || echo \"$name failed to start\" | tee \"$SERVICE_DIR/$SCREEN_NAME/${name}.failure\"$NL"
Dean Troyerdff49a22014-01-30 15:37:40 -06001424}
1425
1426# Screen rc file builder
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001427# Uses globals ``SCREEN_NAME``, ``SCREENRC``
Dean Troyerdff49a22014-01-30 15:37:40 -06001428# screen_rc service "command-line"
1429function screen_rc {
1430 SCREEN_NAME=${SCREEN_NAME:-stack}
1431 SCREENRC=$TOP_DIR/$SCREEN_NAME-screenrc
1432 if [[ ! -e $SCREENRC ]]; then
1433 # Name the screen session
1434 echo "sessionname $SCREEN_NAME" > $SCREENRC
1435 # Set a reasonable statusbar
1436 echo "hardstatus alwayslastline '$SCREEN_HARDSTATUS'" >> $SCREENRC
1437 # Some distributions override PROMPT_COMMAND for the screen terminal type - turn that off
1438 echo "setenv PROMPT_COMMAND /bin/true" >> $SCREENRC
1439 echo "screen -t shell bash" >> $SCREENRC
1440 fi
1441 # If this service doesn't already exist in the screenrc file
1442 if ! grep $1 $SCREENRC 2>&1 > /dev/null; then
1443 NL=`echo -ne '\015'`
1444 echo "screen -t $1 bash" >> $SCREENRC
1445 echo "stuff \"$2$NL\"" >> $SCREENRC
1446
Dean Troyerdde41d02014-12-09 17:47:57 -06001447 if [[ -n ${LOGDIR} ]]; then
1448 echo "logfile ${LOGDIR}/${1}.log.${CURRENT_LOG_TIME}" >>$SCREENRC
Dean Troyerdff49a22014-01-30 15:37:40 -06001449 echo "log on" >>$SCREENRC
1450 fi
1451 fi
1452}
1453
1454# Stop a service in screen
1455# If a PID is available use it, kill the whole process group via TERM
1456# If screen is being used kill the screen window; this will catch processes
1457# that did not leave a PID behind
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001458# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``, ``USE_SCREEN``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001459# screen_stop_service service
Dean Troyer3159a822014-08-27 14:13:58 -05001460function screen_stop_service {
1461 local service=$1
1462
Dean Troyerdff49a22014-01-30 15:37:40 -06001463 SCREEN_NAME=${SCREEN_NAME:-stack}
1464 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001465 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyerdff49a22014-01-30 15:37:40 -06001466
Dean Troyer3159a822014-08-27 14:13:58 -05001467 if is_service_enabled $service; then
1468 # Clean up the screen window
Attila Fazekasf750a6f2015-07-01 12:17:35 +02001469 screen -S $SCREEN_NAME -p $service -X kill || true
Dean Troyer3159a822014-08-27 14:13:58 -05001470 fi
1471}
1472
1473# Stop a service process
1474# If a PID is available use it, kill the whole process group via TERM
1475# If screen is being used kill the screen window; this will catch processes
1476# that did not leave a PID behind
1477# Uses globals ``SERVICE_DIR``, ``USE_SCREEN``
1478# stop_process service
1479function stop_process {
1480 local service=$1
1481
1482 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001483 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyer3159a822014-08-27 14:13:58 -05001484
1485 if is_service_enabled $service; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001486 # Kill via pid if we have one available
Dean Troyer3159a822014-08-27 14:13:58 -05001487 if [[ -r $SERVICE_DIR/$SCREEN_NAME/$service.pid ]]; then
1488 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid)
Dan Smithce7246a2015-04-23 09:41:06 -07001489 # oslo.service tends to stop actually shutting down
1490 # reliably in between releases because someone believes it
1491 # is dying too early due to some inflight work they
1492 # have. This is a tension. It happens often enough we're
1493 # going to just account for it in devstack and assume it
1494 # doesn't work.
1495 #
1496 # Set OSLO_SERVICE_WORKS=True to skip this block
1497 if [[ -z "$OSLO_SERVICE_WORKS" ]]; then
1498 # TODO(danms): Remove this double-kill when we have
1499 # this fixed in all services:
1500 # https://bugs.launchpad.net/oslo-incubator/+bug/1446583
1501 sleep 1
1502 # /bin/true becakse pkill on a non existant process returns an error
1503 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid) || /bin/true
1504 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001505 rm $SERVICE_DIR/$SCREEN_NAME/$service.pid
Dean Troyerdff49a22014-01-30 15:37:40 -06001506 fi
1507 if [[ "$USE_SCREEN" = "True" ]]; then
1508 # Clean up the screen window
Dean Troyer3159a822014-08-27 14:13:58 -05001509 screen_stop_service $service
Dean Troyerdff49a22014-01-30 15:37:40 -06001510 fi
1511 fi
1512}
1513
1514# Helper to get the status of each running service
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001515# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001516# service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001517function service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001518 local service
1519 local failures
1520 SCREEN_NAME=${SCREEN_NAME:-stack}
1521 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1522
1523
1524 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1525 echo "No service status directory found"
1526 return
1527 fi
1528
Wei Jiangange3340f12015-09-21 17:52:14 +08001529 # Check if there is any failure flag file under $SERVICE_DIR/$SCREEN_NAME
Sean Dague09bd7c82014-02-03 08:35:26 +09001530 # make this -o errexit safe
1531 failures=`ls "$SERVICE_DIR/$SCREEN_NAME"/*.failure 2>/dev/null || /bin/true`
Dean Troyerdff49a22014-01-30 15:37:40 -06001532
1533 for service in $failures; do
1534 service=`basename $service`
1535 service=${service%.failure}
1536 echo "Error: Service $service is not running"
1537 done
1538
1539 if [ -n "$failures" ]; then
Sean Dague12379222014-02-27 17:16:46 -05001540 die $LINENO "More details about the above errors can be found with screen, with ./rejoin-stack.sh"
Dean Troyerdff49a22014-01-30 15:37:40 -06001541 fi
1542}
1543
Chris Dent2f27a0e2014-09-09 13:46:02 +01001544# Tail a log file in a screen if USE_SCREEN is true.
1545function tail_log {
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001546 local name=$1
Chris Dent2f27a0e2014-09-09 13:46:02 +01001547 local logfile=$2
1548
Sean Dague53753292014-12-04 19:38:15 -05001549 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Chris Dent2f27a0e2014-09-09 13:46:02 +01001550 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001551 screen_process "$name" "sudo tail -f $logfile"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001552 fi
1553}
1554
Dean Troyerdff49a22014-01-30 15:37:40 -06001555
Dean Troyer3159a822014-08-27 14:13:58 -05001556# Deprecated Functions
1557# --------------------
1558
1559# _old_run_process() is designed to be backgrounded by old_run_process() to simulate a
1560# fork. It includes the dirty work of closing extra filehandles and preparing log
1561# files to produce the same logs as screen_it(). The log filename is derived
1562# from the service name and global-and-now-misnamed ``SCREEN_LOGDIR``
1563# Uses globals ``CURRENT_LOG_TIME``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
1564# _old_run_process service "command-line"
1565function _old_run_process {
1566 local service=$1
1567 local command="$2"
1568
1569 # Undo logging redirections and close the extra descriptors
1570 exec 1>&3
1571 exec 2>&3
1572 exec 3>&-
1573 exec 6>&-
1574
1575 if [[ -n ${SCREEN_LOGDIR} ]]; then
Dean Troyerad5cc982014-12-10 16:35:32 -06001576 exec 1>&${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} 2>&1
1577 ln -sf ${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} ${SCREEN_LOGDIR}/screen-${1}.log
Dean Troyer3159a822014-08-27 14:13:58 -05001578
1579 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1580 export PYTHONUNBUFFERED=1
1581 fi
1582
1583 exec /bin/bash -c "$command"
1584 die "$service exec failure: $command"
1585}
1586
1587# old_run_process() launches a child process that closes all file descriptors and
1588# then exec's the passed in command. This is meant to duplicate the semantics
1589# of screen_it() without screen. PIDs are written to
1590# ``$SERVICE_DIR/$SCREEN_NAME/$service.pid`` by the spawned child process.
1591# old_run_process service "command-line"
1592function old_run_process {
1593 local service=$1
1594 local command="$2"
1595
1596 # Spawn the child process
1597 _old_run_process "$service" "$command" &
1598 echo $!
1599}
1600
1601# Compatibility for existing start_XXXX() functions
1602# Uses global ``USE_SCREEN``
1603# screen_it service "command-line"
1604function screen_it {
1605 if is_service_enabled $1; then
1606 # Append the service to the screen rc file
1607 screen_rc "$1" "$2"
1608
1609 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001610 screen_process "$1" "$2"
Dean Troyer3159a822014-08-27 14:13:58 -05001611 else
1612 # Spawn directly without screen
1613 old_run_process "$1" "$2" >$SERVICE_DIR/$SCREEN_NAME/$1.pid
1614 fi
1615 fi
1616}
1617
1618# Compatibility for existing stop_XXXX() functions
1619# Stop a service in screen
1620# If a PID is available use it, kill the whole process group via TERM
1621# If screen is being used kill the screen window; this will catch processes
1622# that did not leave a PID behind
1623# screen_stop service
1624function screen_stop {
1625 # Clean up the screen window
1626 stop_process $1
1627}
1628
1629
Sean Dague2c65e712014-12-18 09:44:56 -05001630# Plugin Functions
1631# =================
1632
1633DEVSTACK_PLUGINS=${DEVSTACK_PLUGINS:-""}
1634
1635# enable_plugin <name> <url> [branch]
1636#
1637# ``name`` is an arbitrary name - (aka: glusterfs, nova-docker, zaqar)
1638# ``url`` is a git url
1639# ``branch`` is a gitref. If it's not set, defaults to master
1640function enable_plugin {
1641 local name=$1
1642 local url=$2
1643 local branch=${3:-master}
1644 DEVSTACK_PLUGINS+=",$name"
1645 GITREPO[$name]=$url
1646 GITDIR[$name]=$DEST/$name
1647 GITBRANCH[$name]=$branch
1648}
1649
1650# fetch_plugins
1651#
1652# clones all plugins
1653function fetch_plugins {
1654 local plugins="${DEVSTACK_PLUGINS}"
1655 local plugin
1656
1657 # short circuit if nothing to do
1658 if [[ -z $plugins ]]; then
1659 return
1660 fi
1661
Dean Troyerdc97cb72015-03-28 08:20:50 -05001662 echo "Fetching DevStack plugins"
Sean Dague2c65e712014-12-18 09:44:56 -05001663 for plugin in ${plugins//,/ }; do
1664 git_clone_by_name $plugin
1665 done
1666}
1667
1668# load_plugin_settings
1669#
1670# Load settings from plugins in the order that they were registered
1671function load_plugin_settings {
1672 local plugins="${DEVSTACK_PLUGINS}"
1673 local plugin
1674
1675 # short circuit if nothing to do
1676 if [[ -z $plugins ]]; then
1677 return
1678 fi
1679
1680 echo "Loading plugin settings"
1681 for plugin in ${plugins//,/ }; do
1682 local dir=${GITDIR[$plugin]}
1683 # source any known settings
1684 if [[ -f $dir/devstack/settings ]]; then
1685 source $dir/devstack/settings
1686 fi
1687 done
1688}
1689
Sean Dague6e275e12015-03-26 05:54:28 -04001690# plugin_override_defaults
1691#
1692# Run an extremely early setting phase for plugins that allows default
1693# overriding of services.
1694function plugin_override_defaults {
1695 local plugins="${DEVSTACK_PLUGINS}"
1696 local plugin
1697
1698 # short circuit if nothing to do
1699 if [[ -z $plugins ]]; then
1700 return
1701 fi
1702
1703 echo "Overriding Configuration Defaults"
1704 for plugin in ${plugins//,/ }; do
1705 local dir=${GITDIR[$plugin]}
1706 # source any overrides
1707 if [[ -f $dir/devstack/override-defaults ]]; then
1708 # be really verbose that an override is happening, as it
1709 # may not be obvious if things fail later.
1710 echo "$plugin has overriden the following defaults"
1711 cat $dir/devstack/override-defaults
1712 source $dir/devstack/override-defaults
1713 fi
1714 done
1715}
1716
Sean Dague2c65e712014-12-18 09:44:56 -05001717# run_plugins
1718#
1719# Run the devstack/plugin.sh in all the plugin directories. These are
1720# run in registration order.
1721function run_plugins {
1722 local mode=$1
1723 local phase=$2
Bharat Kumar Kobagana441ff072015-01-08 12:26:26 +05301724
1725 local plugins="${DEVSTACK_PLUGINS}"
1726 local plugin
Sean Dague2c65e712014-12-18 09:44:56 -05001727 for plugin in ${plugins//,/ }; do
1728 local dir=${GITDIR[$plugin]}
1729 if [[ -f $dir/devstack/plugin.sh ]]; then
1730 source $dir/devstack/plugin.sh $mode $phase
1731 fi
1732 done
1733}
1734
1735function run_phase {
1736 local mode=$1
1737 local phase=$2
1738 if [[ -d $TOP_DIR/extras.d ]]; then
Dmitry Tantsur64be3212015-10-12 13:10:24 +02001739 local extra_plugin_file_name
1740 for extra_plugin_file_name in $TOP_DIR/extras.d/*.sh; do
1741 [[ -r $extra_plugin_file_name ]] && source $extra_plugin_file_name $mode $phase
Sean Dague1de9e332015-10-07 08:46:13 -04001742 # NOTE(sdague): generate a big warning about using
1743 # extras.d in an unsupported way which will let us track
1744 # unsupported usage in the gate.
1745 local exceptions="50-ironic.sh 60-ceph.sh 80-tempest.sh"
Ian Wienand5cdee8d2015-10-19 14:17:18 +11001746 local extra
1747 extra=$(basename $extra_plugin_file_name)
Sean Dague1de9e332015-10-07 08:46:13 -04001748 if [[ ! ( $exceptions =~ "$extra" ) ]]; then
1749 deprecated "extras.d support is being removed in Mitaka-1"
1750 deprecated "jobs for project $extra will break after that point"
1751 deprecated "please move project to a supported devstack plugin model"
1752 fi
Sean Dague2c65e712014-12-18 09:44:56 -05001753 done
1754 fi
1755 # the source phase corresponds to settings loading in plugins
1756 if [[ "$mode" == "source" ]]; then
1757 load_plugin_settings
Chris Dentc6d47012015-10-09 14:57:05 +00001758 verify_disabled_services
Sean Dague6e275e12015-03-26 05:54:28 -04001759 elif [[ "$mode" == "override_defaults" ]]; then
1760 plugin_override_defaults
Sean Dague2c65e712014-12-18 09:44:56 -05001761 else
1762 run_plugins $mode $phase
1763 fi
1764}
1765
Dean Troyerdff49a22014-01-30 15:37:40 -06001766
1767# Service Functions
1768# =================
1769
1770# remove extra commas from the input string (i.e. ``ENABLED_SERVICES``)
1771# _cleanup_service_list service-list
Ian Wienandaee18c72014-02-21 15:35:08 +11001772function _cleanup_service_list {
Dean Troyerdff49a22014-01-30 15:37:40 -06001773 echo "$1" | sed -e '
1774 s/,,/,/g;
1775 s/^,//;
1776 s/,$//
1777 '
1778}
1779
1780# disable_all_services() removes all current services
1781# from ``ENABLED_SERVICES`` to reset the configuration
1782# before a minimal installation
1783# Uses global ``ENABLED_SERVICES``
1784# disable_all_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001785function disable_all_services {
Dean Troyerdff49a22014-01-30 15:37:40 -06001786 ENABLED_SERVICES=""
1787}
1788
1789# Remove all services starting with '-'. For example, to install all default
1790# services except rabbit (rabbit) set in ``localrc``:
1791# ENABLED_SERVICES+=",-rabbit"
1792# Uses global ``ENABLED_SERVICES``
1793# disable_negated_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001794function disable_negated_services {
Ian Wienand2796a822015-04-15 08:59:04 +10001795 local to_remove=""
1796 local remaining=""
Dean Troyerdff49a22014-01-30 15:37:40 -06001797 local service
Ian Wienand2796a822015-04-15 08:59:04 +10001798
1799 # build up list of services that should be removed; i.e. they
1800 # begin with "-"
1801 for service in ${ENABLED_SERVICES//,/ }; do
Dean Troyerdff49a22014-01-30 15:37:40 -06001802 if [[ ${service} == -* ]]; then
Ian Wienand2796a822015-04-15 08:59:04 +10001803 to_remove+=",${service#-}"
1804 else
1805 remaining+=",${service}"
Dean Troyerdff49a22014-01-30 15:37:40 -06001806 fi
1807 done
Ian Wienand2796a822015-04-15 08:59:04 +10001808
1809 # go through the service list. if this service appears in the "to
1810 # be removed" list, drop it
fumihiko kakuma8606c982015-04-13 09:55:06 +09001811 ENABLED_SERVICES=$(remove_disabled_services "$remaining" "$to_remove")
Dean Troyerdff49a22014-01-30 15:37:40 -06001812}
1813
Chris Dentc6d47012015-10-09 14:57:05 +00001814# disable_service() prepares the services passed as argument to be
1815# removed from the ``ENABLED_SERVICES`` list, if they are present.
Dean Troyerdff49a22014-01-30 15:37:40 -06001816#
1817# For example:
1818# disable_service rabbit
1819#
Chris Dentc6d47012015-10-09 14:57:05 +00001820# Uses global ``DISABLED_SERVICES``
Dean Troyerdff49a22014-01-30 15:37:40 -06001821# disable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001822function disable_service {
Chris Dentc6d47012015-10-09 14:57:05 +00001823 local disabled_svcs="${DISABLED_SERVICES}"
1824 local enabled_svcs=",${ENABLED_SERVICES},"
Dean Troyerdff49a22014-01-30 15:37:40 -06001825 local service
1826 for service in $@; do
Chris Dentc6d47012015-10-09 14:57:05 +00001827 disabled_svcs+=",$service"
Dean Troyerdff49a22014-01-30 15:37:40 -06001828 if is_service_enabled $service; then
Chris Dentc6d47012015-10-09 14:57:05 +00001829 enabled_svcs=${enabled_svcs//,$service,/,}
Dean Troyerdff49a22014-01-30 15:37:40 -06001830 fi
1831 done
Chris Dentc6d47012015-10-09 14:57:05 +00001832 DISABLED_SERVICES=$(_cleanup_service_list "$disabled_svcs")
1833 ENABLED_SERVICES=$(_cleanup_service_list "$enabled_svcs")
Dean Troyerdff49a22014-01-30 15:37:40 -06001834}
1835
1836# enable_service() adds the services passed as argument to the
1837# ``ENABLED_SERVICES`` list, if they are not already present.
1838#
1839# For example:
Sean Dague37eca482015-06-16 07:19:22 -04001840# enable_service q-svc
Dean Troyerdff49a22014-01-30 15:37:40 -06001841#
1842# This function does not know about the special cases
1843# for nova, glance, and neutron built into is_service_enabled().
1844# Uses global ``ENABLED_SERVICES``
1845# enable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001846function enable_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06001847 local tmpsvcs="${ENABLED_SERVICES}"
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001848 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06001849 for service in $@; do
Chris Dentc6d47012015-10-09 14:57:05 +00001850 if [[ ,${DISABLED_SERVICES}, =~ ,${service}, ]]; then
1851 warn $LINENO "Attempt to enable_service ${service} when it has been disabled"
1852 continue
1853 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001854 if ! is_service_enabled $service; then
1855 tmpsvcs+=",$service"
1856 fi
1857 done
1858 ENABLED_SERVICES=$(_cleanup_service_list "$tmpsvcs")
1859 disable_negated_services
1860}
1861
1862# is_service_enabled() checks if the service(s) specified as arguments are
1863# enabled by the user in ``ENABLED_SERVICES``.
1864#
1865# Multiple services specified as arguments are ``OR``'ed together; the test
1866# is a short-circuit boolean, i.e it returns on the first match.
1867#
1868# There are special cases for some 'catch-all' services::
1869# **nova** returns true if any service enabled start with **n-**
1870# **cinder** returns true if any service enabled start with **c-**
Dean Troyerdff49a22014-01-30 15:37:40 -06001871# **glance** returns true if any service enabled start with **g-**
1872# **neutron** returns true if any service enabled start with **q-**
1873# **swift** returns true if any service enabled start with **s-**
1874# **trove** returns true if any service enabled start with **tr-**
1875# For backward compatibility if we have **swift** in ENABLED_SERVICES all the
1876# **s-** services will be enabled. This will be deprecated in the future.
1877#
1878# Cells within nova is enabled if **n-cell** is in ``ENABLED_SERVICES``.
1879# We also need to make sure to treat **n-cell-region** and **n-cell-child**
1880# as enabled in this case.
1881#
1882# Uses global ``ENABLED_SERVICES``
1883# is_service_enabled service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001884function is_service_enabled {
Ian Wienand433a9b12015-10-07 13:29:31 +11001885 local xtrace
1886 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -05001887 set +o xtrace
1888 local enabled=1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001889 local services=$@
1890 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06001891 for service in ${services}; do
Sean Dague45917cc2014-02-24 16:09:14 -05001892 [[ ,${ENABLED_SERVICES}, =~ ,${service}, ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001893
1894 # Look for top-level 'enabled' function for this service
1895 if type is_${service}_enabled >/dev/null 2>&1; then
1896 # A function exists for this service, use it
Christian Schwede3db0aad2015-09-10 11:15:39 +00001897 is_${service}_enabled && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001898 fi
1899
1900 # TODO(dtroyer): Remove these legacy special-cases after the is_XXX_enabled()
1901 # are implemented
1902
Sean Dague45917cc2014-02-24 16:09:14 -05001903 [[ ${service} == n-cell-* && ${ENABLED_SERVICES} =~ "n-cell" ]] && enabled=0
Chris Dent2f27a0e2014-09-09 13:46:02 +01001904 [[ ${service} == n-cpu-* && ${ENABLED_SERVICES} =~ "n-cpu" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05001905 [[ ${service} == "nova" && ${ENABLED_SERVICES} =~ "n-" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05001906 [[ ${service} == "glance" && ${ENABLED_SERVICES} =~ "g-" ]] && enabled=0
1907 [[ ${service} == "ironic" && ${ENABLED_SERVICES} =~ "ir-" ]] && enabled=0
1908 [[ ${service} == "neutron" && ${ENABLED_SERVICES} =~ "q-" ]] && enabled=0
1909 [[ ${service} == "trove" && ${ENABLED_SERVICES} =~ "tr-" ]] && enabled=0
1910 [[ ${service} == "swift" && ${ENABLED_SERVICES} =~ "s-" ]] && enabled=0
1911 [[ ${service} == s-* && ${ENABLED_SERVICES} =~ "swift" ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001912 done
Sean Dague45917cc2014-02-24 16:09:14 -05001913 $xtrace
1914 return $enabled
Dean Troyerdff49a22014-01-30 15:37:40 -06001915}
1916
fumihiko kakuma8606c982015-04-13 09:55:06 +09001917# remove specified list from the input string
1918# remove_disabled_services service-list remove-list
1919function remove_disabled_services {
1920 local service_list=$1
1921 local remove_list=$2
1922 local service
1923 local enabled=""
1924
1925 for service in ${service_list//,/ }; do
1926 local remove
1927 local add=1
1928 for remove in ${remove_list//,/ }; do
1929 if [[ ${remove} == ${service} ]]; then
1930 add=0
1931 break
1932 fi
1933 done
1934 if [[ $add == 1 ]]; then
1935 enabled="${enabled},$service"
1936 fi
1937 done
1938 _cleanup_service_list "$enabled"
1939}
1940
Dean Troyerdff49a22014-01-30 15:37:40 -06001941# Toggle enable/disable_service for services that must run exclusive of each other
1942# $1 The name of a variable containing a space-separated list of services
1943# $2 The name of a variable in which to store the enabled service's name
1944# $3 The name of the service to enable
1945function use_exclusive_service {
1946 local options=${!1}
1947 local selection=$3
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001948 local out=$2
Dean Troyerdff49a22014-01-30 15:37:40 -06001949 [ -z $selection ] || [[ ! "$options" =~ "$selection" ]] && return 1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001950 local opt
Dean Troyerdff49a22014-01-30 15:37:40 -06001951 for opt in $options;do
1952 [[ "$opt" = "$selection" ]] && enable_service $opt || disable_service $opt
1953 done
1954 eval "$out=$selection"
1955 return 0
1956}
1957
Chris Dentc6d47012015-10-09 14:57:05 +00001958# Make sure that nothing has manipulated ENABLED_SERVICES in a way
1959# that conflicts with prior calls to disable_service.
1960# Uses global ``ENABLED_SERVICES``
1961function verify_disabled_services {
1962 local service
1963 for service in ${ENABLED_SERVICES//,/ }; do
1964 if [[ ,${DISABLED_SERVICES}, =~ ,${service}, ]]; then
1965 die $LINENO "ENABLED_SERVICES directly modified to overcome 'disable_service ${service}'"
1966 fi
1967 done
1968}
1969
Dean Troyerdff49a22014-01-30 15:37:40 -06001970
Masayuki Igawaf6368d32014-02-20 13:31:26 +09001971# System Functions
1972# ================
Dean Troyerdff49a22014-01-30 15:37:40 -06001973
1974# Only run the command if the target file (the last arg) is not on an
1975# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11001976function _safe_permission_operation {
Ian Wienand433a9b12015-10-07 13:29:31 +11001977 local xtrace
1978 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -05001979 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001980 local args=( $@ )
1981 local last
1982 local sudo_cmd
1983 local dir_to_check
1984
1985 let last="${#args[*]} - 1"
1986
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001987 local dir_to_check=${args[$last]}
Dean Troyerdff49a22014-01-30 15:37:40 -06001988 if [ ! -d "$dir_to_check" ]; then
1989 dir_to_check=`dirname "$dir_to_check"`
1990 fi
1991
1992 if is_nfs_directory "$dir_to_check" ; then
Sean Dague45917cc2014-02-24 16:09:14 -05001993 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001994 return 0
1995 fi
1996
1997 if [[ $TRACK_DEPENDS = True ]]; then
1998 sudo_cmd="env"
1999 else
2000 sudo_cmd="sudo"
2001 fi
2002
Sean Dague45917cc2014-02-24 16:09:14 -05002003 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06002004 $sudo_cmd $@
2005}
2006
2007# Exit 0 if address is in network or 1 if address is not in network
2008# ip-range is in CIDR notation: 1.2.3.4/20
2009# address_in_net ip-address ip-range
Ian Wienandaee18c72014-02-21 15:35:08 +11002010function address_in_net {
Dean Troyerdff49a22014-01-30 15:37:40 -06002011 local ip=$1
2012 local range=$2
2013 local masklen=${range#*/}
Ian Wienandada886d2015-10-07 14:06:26 +11002014 local network
2015 network=$(maskip ${range%/*} $(cidr2netmask $masklen))
2016 local subnet
2017 subnet=$(maskip $ip $(cidr2netmask $masklen))
Dean Troyerdff49a22014-01-30 15:37:40 -06002018 [[ $network == $subnet ]]
2019}
2020
2021# Add a user to a group.
2022# add_user_to_group user group
Ian Wienandaee18c72014-02-21 15:35:08 +11002023function add_user_to_group {
Dean Troyerdff49a22014-01-30 15:37:40 -06002024 local user=$1
2025 local group=$2
2026
Thomas Bechtolda8580852015-05-31 00:04:33 +02002027 sudo usermod -a -G "$group" "$user"
Dean Troyerdff49a22014-01-30 15:37:40 -06002028}
2029
2030# Convert CIDR notation to a IPv4 netmask
2031# cidr2netmask cidr-bits
Ian Wienandaee18c72014-02-21 15:35:08 +11002032function cidr2netmask {
Dean Troyerdff49a22014-01-30 15:37:40 -06002033 local maskpat="255 255 255 255"
2034 local maskdgt="254 252 248 240 224 192 128"
2035 set -- ${maskpat:0:$(( ($1 / 8) * 4 ))}${maskdgt:$(( (7 - ($1 % 8)) * 4 )):3}
2036 echo ${1-0}.${2-0}.${3-0}.${4-0}
2037}
2038
2039# Gracefully cp only if source file/dir exists
2040# cp_it source destination
2041function cp_it {
2042 if [ -e $1 ] || [ -d $1 ]; then
2043 cp -pRL $1 $2
2044 fi
2045}
2046
2047# HTTP and HTTPS proxy servers are supported via the usual environment variables [1]
2048# ``http_proxy``, ``https_proxy`` and ``no_proxy``. They can be set in
2049# ``localrc`` or on the command line if necessary::
2050#
2051# [1] http://www.w3.org/Daemon/User/Proxies/ProxyClients.html
2052#
2053# http_proxy=http://proxy.example.com:3128/ no_proxy=repo.example.net ./stack.sh
2054
Ian Wienandaee18c72014-02-21 15:35:08 +11002055function export_proxy_variables {
Sean Dague53753292014-12-04 19:38:15 -05002056 if isset http_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002057 export http_proxy=$http_proxy
2058 fi
Sean Dague53753292014-12-04 19:38:15 -05002059 if isset https_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002060 export https_proxy=$https_proxy
2061 fi
Sean Dague53753292014-12-04 19:38:15 -05002062 if isset no_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002063 export no_proxy=$no_proxy
2064 fi
2065}
2066
2067# Returns true if the directory is on a filesystem mounted via NFS.
Ian Wienandaee18c72014-02-21 15:35:08 +11002068function is_nfs_directory {
Ian Wienandada886d2015-10-07 14:06:26 +11002069 local mount_type
2070 mount_type=`stat -f -L -c %T $1`
Dean Troyerdff49a22014-01-30 15:37:40 -06002071 test "$mount_type" == "nfs"
2072}
2073
2074# Return the network portion of the given IP address using netmask
2075# netmask is in the traditional dotted-quad format
2076# maskip ip-address netmask
Ian Wienandaee18c72014-02-21 15:35:08 +11002077function maskip {
Dean Troyerdff49a22014-01-30 15:37:40 -06002078 local ip=$1
2079 local mask=$2
2080 local l="${ip%.*}"; local r="${ip#*.}"; local n="${mask%.*}"; local m="${mask#*.}"
Ian Wienandada886d2015-10-07 14:06:26 +11002081 local subnet
2082 subnet=$((${ip%%.*}&${mask%%.*})).$((${r%%.*}&${m%%.*})).$((${l##*.}&${n##*.})).$((${ip##*.}&${mask##*.}))
Dean Troyerdff49a22014-01-30 15:37:40 -06002083 echo $subnet
2084}
2085
Chris Dent3a2c86a2015-05-12 13:41:25 +00002086# Return the current python as "python<major>.<minor>"
2087function python_version {
Ian Wienandada886d2015-10-07 14:06:26 +11002088 local python_version
2089 python_version=$(python -c 'import sys; print("%s.%s" % sys.version_info[0:2])')
Chris Dent3a2c86a2015-05-12 13:41:25 +00002090 echo "python${python_version}"
2091}
2092
Dean Troyerdff49a22014-01-30 15:37:40 -06002093# Service wrapper to restart services
2094# restart_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002095function restart_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002096 if is_ubuntu; then
2097 sudo /usr/sbin/service $1 restart
2098 else
2099 sudo /sbin/service $1 restart
2100 fi
2101}
2102
2103# Only change permissions of a file or directory if it is not on an
2104# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002105function safe_chmod {
Dean Troyerdff49a22014-01-30 15:37:40 -06002106 _safe_permission_operation chmod $@
2107}
2108
2109# Only change ownership of a file or directory if it is not on an NFS
2110# filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002111function safe_chown {
Dean Troyerdff49a22014-01-30 15:37:40 -06002112 _safe_permission_operation chown $@
2113}
2114
2115# Service wrapper to start services
2116# start_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002117function start_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002118 if is_ubuntu; then
2119 sudo /usr/sbin/service $1 start
2120 else
2121 sudo /sbin/service $1 start
2122 fi
2123}
2124
2125# Service wrapper to stop services
2126# stop_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002127function stop_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002128 if is_ubuntu; then
2129 sudo /usr/sbin/service $1 stop
2130 else
2131 sudo /sbin/service $1 stop
2132 fi
2133}
2134
Sean Dague442e4e92015-06-24 13:24:02 -04002135# Test with a finite retry loop.
2136#
2137function test_with_retry {
2138 local testcmd=$1
2139 local failmsg=$2
2140 local until=${3:-10}
2141 local sleep=${4:-0.5}
2142
2143 if ! timeout $until sh -c "while ! $testcmd; do sleep $sleep; done"; then
2144 die $LINENO "$failmsg"
2145 fi
2146}
2147
Sean Dague95c33d52015-10-07 11:05:59 -04002148# Timing infrastructure - figure out where large blocks of time are
2149# used in DevStack
2150#
2151# The timing infrastructure for DevStack is about collecting buckets
2152# of time that are spend in some subtask. For instance, that might be
2153# 'apt', 'pip', 'osc', even database migrations. We do this by a pair
2154# of functions: time_start / time_stop.
2155#
2156# These take a single parameter: $name - which specifies the name of
2157# the bucket to be accounted against. time_totals function spits out
2158# the results.
2159#
2160# Resolution is only in whole seconds, so should be used for long
2161# running activities.
2162
2163declare -A TOTAL_TIME
2164declare -A START_TIME
2165
2166# time_start $name
2167#
2168# starts the clock for a timer by name. Errors if that clock is
2169# already started.
2170function time_start {
2171 local name=$1
2172 local start_time=${START_TIME[$name]}
2173 if [[ -n "$start_time" ]]; then
2174 die $LINENO "Trying to start the clock on $name, but it's already been started"
2175 fi
2176 START_TIME[$name]=$(date +%s)
2177}
2178
2179# time_stop $name
2180#
2181# stops the clock for a timer by name, and accumulate that time in the
2182# global counter for that name. Errors if that clock had not
2183# previously been started.
2184function time_stop {
Ian Wienand5cdee8d2015-10-19 14:17:18 +11002185 local name
2186 local end_time
2187 local elpased_time
2188 local total
2189 local start_time
2190
2191 name=$1
2192 start_time=${START_TIME[$name]}
2193
Sean Dague95c33d52015-10-07 11:05:59 -04002194 if [[ -z "$start_time" ]]; then
2195 die $LINENO "Trying to stop the clock on $name, but it was never started"
2196 fi
Ian Wienand5cdee8d2015-10-19 14:17:18 +11002197 end_time=$(date +%s)
2198 elapsed_time=$(($end_time - $start_time))
2199 total=${TOTAL_TIME[$name]:-0}
Sean Dague95c33d52015-10-07 11:05:59 -04002200 # reset the clock so we can start it in the future
2201 START_TIME[$name]=""
2202 TOTAL_TIME[$name]=$(($total + $elapsed_time))
2203}
2204
2205# time_totals
2206#
2207# prints out total time
2208function time_totals {
2209 echo
2210 echo "========================"
2211 echo "DevStack Components Timed"
2212 echo "========================"
2213 echo
2214 for t in ${!TOTAL_TIME[*]}; do
2215 local v=${TOTAL_TIME[$t]}
2216 echo "$t - $v secs"
2217 done
2218}
Dean Troyerdff49a22014-01-30 15:37:40 -06002219
2220# Restore xtrace
2221$XTRACE
2222
2223# Local variables:
2224# mode: shell-script
2225# End: