blob: 90217c955f203968f3da797cebd66b4e369a6ac4 [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
Ian Wienand523f4882015-10-13 11:03:03 +110035_XTRACE_FUNCTIONS_COMMON=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -060036set +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 {
Monty Tayloree9bb762015-10-19 15:16:18 -040076 # The location is a variable to allow for easier refactoring later to make it
77 # overridable. There is currently no usecase where doing so makes sense, so
78 # it's not currently configurable.
Monty Taylor7224eec2015-09-19 11:26:18 -040079
Monty Tayloree9bb762015-10-19 15:16:18 -040080 CLOUDS_YAML=/etc/openstack/clouds.yaml
81
82 sudo mkdir -p $(dirname $CLOUDS_YAML)
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +030083 sudo chown -R $STACK_USER /etc/openstack
Lenny Verkhovsky313ddae2015-10-20 11:26:34 +030084
Monty Tayloree9bb762015-10-19 15:16:18 -040085 CA_CERT_ARG=''
86 if [ -f "$SSL_BUNDLE_FILE" ]; then
87 CA_CERT_ARG="--os-cacert $SSL_BUNDLE_FILE"
88 fi
Sean Daguec67d22e2016-02-02 05:51:14 -050089 # demo -> devstack
Monty Tayloree9bb762015-10-19 15:16:18 -040090 $TOP_DIR/tools/update_clouds_yaml.py \
91 --file $CLOUDS_YAML \
92 --os-cloud devstack \
93 --os-region-name $REGION_NAME \
94 --os-identity-api-version 3 \
95 $CA_CERT_ARG \
96 --os-auth-url $KEYSTONE_AUTH_URI \
97 --os-username demo \
98 --os-password $ADMIN_PASSWORD \
99 --os-project-name demo
Sean Daguec67d22e2016-02-02 05:51:14 -0500100
101 # alt_demo -> devstack-alt
102 $TOP_DIR/tools/update_clouds_yaml.py \
103 --file $CLOUDS_YAML \
Clark Boylane20cb432016-02-05 12:00:18 -0800104 --os-cloud devstack-alt \
Sean Daguec67d22e2016-02-02 05:51:14 -0500105 --os-region-name $REGION_NAME \
106 --os-identity-api-version 3 \
107 $CA_CERT_ARG \
108 --os-auth-url $KEYSTONE_AUTH_URI \
109 --os-username alt_demo \
110 --os-password $ADMIN_PASSWORD \
111 --os-project-name alt_demo
112
113 # admin -> devstack-admin
Monty Tayloree9bb762015-10-19 15:16:18 -0400114 $TOP_DIR/tools/update_clouds_yaml.py \
115 --file $CLOUDS_YAML \
116 --os-cloud devstack-admin \
117 --os-region-name $REGION_NAME \
118 --os-identity-api-version 3 \
119 $CA_CERT_ARG \
120 --os-auth-url $KEYSTONE_AUTH_URI \
121 --os-username admin \
122 --os-password $ADMIN_PASSWORD \
123 --os-project-name admin
Monty Taylor74379df2016-01-21 10:20:08 -0500124
125 # CLean up any old clouds.yaml files we had laying around
126 rm -f ~$STACK_USER/.config/openstack/clouds.yaml
Monty Taylor7224eec2015-09-19 11:26:18 -0400127}
128
Ian Wienande82bac02015-08-25 14:29:08 +1000129# trueorfalse <True|False> <VAR>
130#
131# Normalize config-value provided in variable VAR to either "True" or
132# "False". If VAR is unset (i.e. $VAR evaluates as empty), the value
133# of the second argument will be used as the default value.
134#
135# Accepts as False: 0 no No NO false False FALSE
136# Accepts as True: 1 yes Yes YES true True TRUE
137#
138# usage:
139# VAL=$(trueorfalse False VAL)
Ian Wienandaee18c72014-02-21 15:35:08 +1100140function trueorfalse {
Ian Wienand433a9b12015-10-07 13:29:31 +1100141 local xtrace
142 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -0500143 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600144
Mahito OGURA98f59aa2015-05-11 18:02:34 +0900145 local default=$1
Ian Wienande82bac02015-08-25 14:29:08 +1000146
147 if [ -z $2 ]; then
148 die $LINENO "variable to normalize required"
149 fi
Mahito OGURA98f59aa2015-05-11 18:02:34 +0900150 local testval=${!2:-}
151
152 case "$testval" in
153 "1" | [yY]es | "YES" | [tT]rue | "TRUE" ) echo "True" ;;
154 "0" | [nN]o | "NO" | [fF]alse | "FALSE" ) echo "False" ;;
155 * ) echo "$default" ;;
156 esac
157
Sean Dague45917cc2014-02-24 16:09:14 -0500158 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600159}
160
Attila Fazekas1bd79592015-02-24 14:06:56 +0100161function isset {
162 [[ -v "$1" ]]
163}
Dean Troyerdff49a22014-01-30 15:37:40 -0600164
Dean Troyer68162342015-05-13 15:41:03 -0500165
Dean Troyerdff49a22014-01-30 15:37:40 -0600166# Control Functions
167# =================
168
169# Prints backtrace info
170# filename:lineno:function
171# backtrace level
172function backtrace {
173 local level=$1
Ian Wienandada886d2015-10-07 14:06:26 +1100174 local deep
175 deep=$((${#BASH_SOURCE[@]} - 1))
Dean Troyerdff49a22014-01-30 15:37:40 -0600176 echo "[Call Trace]"
177 while [ $level -le $deep ]; do
178 echo "${BASH_SOURCE[$deep]}:${BASH_LINENO[$deep-1]}:${FUNCNAME[$deep-1]}"
179 deep=$((deep - 1))
180 done
181}
182
183# Prints line number and "message" then exits
184# die $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100185function die {
Dean Troyerdff49a22014-01-30 15:37:40 -0600186 local exitcode=$?
187 set +o xtrace
188 local line=$1; shift
189 if [ $exitcode == 0 ]; then
190 exitcode=1
191 fi
192 backtrace 2
193 err $line "$*"
Dean Troyera25a6f62014-02-24 16:03:41 -0600194 # Give buffers a second to flush
195 sleep 1
Dean Troyerdff49a22014-01-30 15:37:40 -0600196 exit $exitcode
197}
198
199# Checks an environment variable is not set or has length 0 OR if the
200# exit code is non-zero and prints "message" and exits
201# NOTE: env-var is the variable name without a '$'
202# die_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100203function die_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600204 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100205 local xtrace
206 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600207 set +o xtrace
208 local line=$1; shift
209 local evar=$1; shift
210 if ! is_set $evar || [ $exitcode != 0 ]; then
211 die $line "$*"
212 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500213 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600214}
215
Sean Dague1de9e332015-10-07 08:46:13 -0400216function deprecated {
217 local text=$1
218 DEPRECATED_TEXT+="\n$text"
219 echo "WARNING: $text"
220}
221
Dean Troyerdff49a22014-01-30 15:37:40 -0600222# Prints line number and "message" in error format
223# err $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100224function err {
Dean Troyerdff49a22014-01-30 15:37:40 -0600225 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100226 local xtrace
227 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600228 set +o xtrace
229 local msg="[ERROR] ${BASH_SOURCE[2]}:$1 $2"
230 echo $msg 1>&2;
Dean Troyerdde41d02014-12-09 17:47:57 -0600231 if [[ -n ${LOGDIR} ]]; then
232 echo $msg >> "${LOGDIR}/error.log"
Dean Troyerdff49a22014-01-30 15:37:40 -0600233 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500234 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600235 return $exitcode
236}
237
238# Checks an environment variable is not set or has length 0 OR if the
239# exit code is non-zero and prints "message"
240# NOTE: env-var is the variable name without a '$'
241# err_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100242function err_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600243 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100244 local xtrace
245 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600246 set +o xtrace
247 local line=$1; shift
248 local evar=$1; shift
249 if ! is_set $evar || [ $exitcode != 0 ]; then
250 err $line "$*"
251 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500252 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600253 return $exitcode
254}
255
256# Exit after outputting a message about the distribution not being supported.
257# exit_distro_not_supported [optional-string-telling-what-is-missing]
258function exit_distro_not_supported {
259 if [[ -z "$DISTRO" ]]; then
260 GetDistro
261 fi
262
263 if [ $# -gt 0 ]; then
264 die $LINENO "Support for $DISTRO is incomplete: no support for $@"
265 else
266 die $LINENO "Support for $DISTRO is incomplete."
267 fi
268}
269
270# Test if the named environment variable is set and not zero length
271# is_set env-var
Ian Wienandaee18c72014-02-21 15:35:08 +1100272function is_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600273 local var=\$"$1"
274 eval "[ -n \"$var\" ]" # For ex.: sh -c "[ -n \"$var\" ]" would be better, but several exercises depends on this
275}
276
277# Prints line number and "message" in warning format
278# warn $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100279function warn {
Dean Troyerdff49a22014-01-30 15:37:40 -0600280 local exitcode=$?
Ian Wienand433a9b12015-10-07 13:29:31 +1100281 local xtrace
282 xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600283 set +o xtrace
284 local msg="[WARNING] ${BASH_SOURCE[2]}:$1 $2"
Sean Daguee4af9292015-04-28 08:57:57 -0400285 echo $msg
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500286 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600287 return $exitcode
288}
289
290
291# Distro Functions
292# ================
293
294# Determine OS Vendor, Release and Update
Ian Wienand7710e7f2014-08-27 16:15:32 +1000295
296#
297# NOTE : For portability, you almost certainly do not want to use
298# these variables directly! The "is_*" functions defined below this
299# bundle up compatible platforms under larger umbrellas that we have
300# determinted are compatible enough (e.g. is_ubuntu covers Ubuntu &
301# Debian, is_fedora covers RPM-based distros). Higher-level functions
302# such as "install_package" further abstract things in better ways.
303#
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500304# ``os_VENDOR`` - vendor name: ``Ubuntu``, ``Fedora``, etc
305# ``os_RELEASE`` - major release: ``14.04`` (Ubuntu), ``20`` (Fedora)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500306# ``os_PACKAGE`` - package type: ``deb`` or ``rpm``
Ian Wienand7710e7f2014-08-27 16:15:32 +1000307# ``os_CODENAME`` - vendor's codename for release: ``trusty``
308
309declare os_VENDOR os_RELEASE os_PACKAGE os_CODENAME
310
311# Make a *best effort* attempt to install lsb_release packages for the
312# user if not available. Note can't use generic install_package*
313# because they depend on this!
314function _ensure_lsb_release {
315 if [[ -x $(which lsb_release 2>/dev/null) ]]; then
316 return
317 fi
318
319 if [[ -x $(which apt-get 2>/dev/null) ]]; then
320 sudo apt-get install -y lsb-release
321 elif [[ -x $(which zypper 2>/dev/null) ]]; then
322 # XXX: old code paths seem to have assumed SUSE platforms also
323 # had "yum". Keep this ordered above yum so we don't try to
324 # install the rh package. suse calls it just "lsb"
325 sudo zypper -y install lsb
326 elif [[ -x $(which dnf 2>/dev/null) ]]; then
327 sudo dnf install -y redhat-lsb-core
328 elif [[ -x $(which yum 2>/dev/null) ]]; then
329 # all rh patforms (fedora, centos, rhel) have this pkg
330 sudo yum install -y redhat-lsb-core
331 else
332 die $LINENO "Unable to find or auto-install lsb_release"
333 fi
334}
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500335
Dean Troyerdff49a22014-01-30 15:37:40 -0600336# GetOSVersion
Ian Wienand7710e7f2014-08-27 16:15:32 +1000337# Set the following variables:
338# - os_RELEASE
339# - os_CODENAME
340# - os_VENDOR
341# - os_PACKAGE
Ian Wienandaee18c72014-02-21 15:35:08 +1100342function GetOSVersion {
Ian Wienand7710e7f2014-08-27 16:15:32 +1000343 # We only support distros that provide a sane lsb_release
344 _ensure_lsb_release
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500345
Ian Wienand7710e7f2014-08-27 16:15:32 +1000346 os_RELEASE=$(lsb_release -r -s)
347 os_CODENAME=$(lsb_release -c -s)
348 os_VENDOR=$(lsb_release -i -s)
Dean Troyerdff49a22014-01-30 15:37:40 -0600349
Ian Wienand7710e7f2014-08-27 16:15:32 +1000350 if [[ $os_VENDOR =~ (Debian|Ubuntu|LinuxMint) ]]; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600351 os_PACKAGE="deb"
Ian Wienand7710e7f2014-08-27 16:15:32 +1000352 else
353 os_PACKAGE="rpm"
Dean Troyerdff49a22014-01-30 15:37:40 -0600354 fi
Ian Wienand7710e7f2014-08-27 16:15:32 +1000355
356 typeset -xr os_VENDOR
357 typeset -xr os_RELEASE
358 typeset -xr os_PACKAGE
359 typeset -xr os_CODENAME
Dean Troyerdff49a22014-01-30 15:37:40 -0600360}
361
362# Translate the OS version values into common nomenclature
363# Sets global ``DISTRO`` from the ``os_*`` values
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500364declare DISTRO
365
Ian Wienandaee18c72014-02-21 15:35:08 +1100366function GetDistro {
Dean Troyerdff49a22014-01-30 15:37:40 -0600367 GetOSVersion
ptoohill196006652016-02-15 16:07:50 -0600368 if [[ "$os_VENDOR" =~ (Ubuntu) || "$os_VENDOR" =~ (Debian) || \
369 "$os_VENDOR" =~ (LinuxMint) ]]; then
370 # 'Everyone' refers to Ubuntu / Debian / Mint releases by
Ian Wienand7710e7f2014-08-27 16:15:32 +1000371 # the code name adjective
Dean Troyerdff49a22014-01-30 15:37:40 -0600372 DISTRO=$os_CODENAME
373 elif [[ "$os_VENDOR" =~ (Fedora) ]]; then
374 # For Fedora, just use 'f' and the release
375 DISTRO="f$os_RELEASE"
376 elif [[ "$os_VENDOR" =~ (openSUSE) ]]; then
377 DISTRO="opensuse-$os_RELEASE"
378 elif [[ "$os_VENDOR" =~ (SUSE LINUX) ]]; then
Ian Wienand7710e7f2014-08-27 16:15:32 +1000379 # just use major release
380 DISTRO="sle${os_RELEASE%.*}"
381 elif [[ "$os_VENDOR" =~ (Red.*Hat) || \
anju Tiwari6c639c92014-07-15 18:11:54 +0530382 "$os_VENDOR" =~ (CentOS) || \
Evgeny Antyshev718512c2016-03-03 14:47:58 +0000383 "$os_VENDOR" =~ (OracleLinux) || \
384 "$os_VENDOR" =~ (Virtuozzo) ]]; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600385 # Drop the . release as we assume it's compatible
Ian Wienand7710e7f2014-08-27 16:15:32 +1000386 # XXX re-evaluate when we get RHEL10
Dean Troyerdff49a22014-01-30 15:37:40 -0600387 DISTRO="rhel${os_RELEASE::1}"
388 elif [[ "$os_VENDOR" =~ (XenServer) ]]; then
Ian Wienand7710e7f2014-08-27 16:15:32 +1000389 DISTRO="xs${os_RELEASE%.*}"
Alexander Schmidta5ea08b2015-12-02 15:30:44 +0000390 elif [[ "$os_VENDOR" =~ (kvmibm) ]]; then
391 DISTRO="${os_VENDOR}${os_RELEASE::1}"
Dean Troyerdff49a22014-01-30 15:37:40 -0600392 else
Ian Wienand7710e7f2014-08-27 16:15:32 +1000393 die $LINENO "Unable to determine DISTRO"
Dean Troyerdff49a22014-01-30 15:37:40 -0600394 fi
Ian Wienand7710e7f2014-08-27 16:15:32 +1000395 typeset -xr DISTRO
Dean Troyerdff49a22014-01-30 15:37:40 -0600396}
397
398# Utility function for checking machine architecture
399# is_arch arch-type
400function is_arch {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500401 [[ "$(uname -m)" == "$1" ]]
Dean Troyerdff49a22014-01-30 15:37:40 -0600402}
403
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700404# Determine if current distribution is an Oracle distribution
405# is_oraclelinux
406function is_oraclelinux {
407 if [[ -z "$os_VENDOR" ]]; then
408 GetOSVersion
409 fi
410
411 [ "$os_VENDOR" = "OracleLinux" ]
412}
413
414
Dean Troyerdff49a22014-01-30 15:37:40 -0600415# Determine if current distribution is a Fedora-based distribution
416# (Fedora, RHEL, CentOS, etc).
417# is_fedora
418function is_fedora {
419 if [[ -z "$os_VENDOR" ]]; then
420 GetOSVersion
421 fi
422
anju Tiwari6c639c92014-07-15 18:11:54 +0530423 [ "$os_VENDOR" = "Fedora" ] || [ "$os_VENDOR" = "Red Hat" ] || \
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300424 [ "$os_VENDOR" = "CentOS" ] || [ "$os_VENDOR" = "OracleLinux" ] || \
Evgeny Antyshev718512c2016-03-03 14:47:58 +0000425 [ "$os_VENDOR" = "Virtuozzo" ] || [ "$os_VENDOR" = "kvmibm" ]
Dean Troyerdff49a22014-01-30 15:37:40 -0600426}
427
428
429# Determine if current distribution is a SUSE-based distribution
430# (openSUSE, SLE).
431# is_suse
432function is_suse {
433 if [[ -z "$os_VENDOR" ]]; then
434 GetOSVersion
435 fi
436
437 [ "$os_VENDOR" = "openSUSE" ] || [ "$os_VENDOR" = "SUSE LINUX" ]
438}
439
440
441# Determine if current distribution is an Ubuntu-based distribution
442# It will also detect non-Ubuntu but Debian-based distros
443# is_ubuntu
444function is_ubuntu {
445 if [[ -z "$os_PACKAGE" ]]; then
446 GetOSVersion
447 fi
448 [ "$os_PACKAGE" = "deb" ]
449}
450
451
452# Git Functions
453# =============
454
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600455# Returns openstack release name for a given branch name
456# ``get_release_name_from_branch branch-name``
Ian Wienandaee18c72014-02-21 15:35:08 +1100457function get_release_name_from_branch {
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600458 local branch=$1
Adam Gandelman8f385722014-10-14 15:50:18 -0700459 if [[ $branch =~ "stable/" || $branch =~ "proposed/" ]]; then
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600460 echo ${branch#*/}
461 else
462 echo "master"
463 fi
464}
465
Dean Troyerdff49a22014-01-30 15:37:40 -0600466# git clone only if directory doesn't exist already. Since ``DEST`` might not
467# be owned by the installation user, we create the directory and change the
468# ownership to the proper user.
Dean Troyer50cda692014-07-25 11:57:20 -0500469# Set global ``RECLONE=yes`` to simulate a clone when dest-dir exists
470# Set global ``ERROR_ON_CLONE=True`` to abort execution with an error if the git repo
Dean Troyerdff49a22014-01-30 15:37:40 -0600471# does not exist (default is False, meaning the repo will be cloned).
Sean Dague53753292014-12-04 19:38:15 -0500472# Uses globals ``ERROR_ON_CLONE``, ``OFFLINE``, ``RECLONE``
Dean Troyerdff49a22014-01-30 15:37:40 -0600473# git_clone remote dest-dir branch
474function git_clone {
Dean Troyer50cda692014-07-25 11:57:20 -0500475 local git_remote=$1
476 local git_dest=$2
477 local git_ref=$3
Ian Wienandada886d2015-10-07 14:06:26 +1100478 local orig_dir
479 orig_dir=$(pwd)
Jamie Lennox51f0de52014-10-20 16:32:34 +0200480 local git_clone_flags=""
Dean Troyer50cda692014-07-25 11:57:20 -0500481
Sean Dague53753292014-12-04 19:38:15 -0500482 RECLONE=$(trueorfalse False RECLONE)
Kevin Benton59d52f32015-01-17 11:29:12 -0800483 if [[ "${GIT_DEPTH}" -gt 0 ]]; then
Jamie Lennox51f0de52014-10-20 16:32:34 +0200484 git_clone_flags="$git_clone_flags --depth $GIT_DEPTH"
485 fi
486
Dean Troyerdff49a22014-01-30 15:37:40 -0600487 if [[ "$OFFLINE" = "True" ]]; then
488 echo "Running in offline mode, clones already exist"
489 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500490 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600491 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400492 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600493 return
494 fi
495
Dean Troyer50cda692014-07-25 11:57:20 -0500496 if echo $git_ref | egrep -q "^refs"; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600497 # If our branch name is a gerrit style refs/changes/...
Dean Troyer50cda692014-07-25 11:57:20 -0500498 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700499 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
500 echo "The $git_dest project was not found; if this is a gate job, add"
501 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600502 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700503 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200504 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600505 fi
Dean Troyer50cda692014-07-25 11:57:20 -0500506 cd $git_dest
507 git_timed fetch $git_remote $git_ref && git checkout FETCH_HEAD
Dean Troyerdff49a22014-01-30 15:37:40 -0600508 else
509 # do a full clone only if the directory doesn't exist
Dean Troyer50cda692014-07-25 11:57:20 -0500510 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700511 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
512 echo "The $git_dest project was not found; if this is a gate job, add"
513 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600514 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700515 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200516 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyer50cda692014-07-25 11:57:20 -0500517 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600518 # This checkout syntax works for both branches and tags
Dean Troyer50cda692014-07-25 11:57:20 -0500519 git checkout $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600520 elif [[ "$RECLONE" = "True" ]]; then
521 # if it does exist then simulate what clone does if asked to RECLONE
Dean Troyer50cda692014-07-25 11:57:20 -0500522 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600523 # set the url to pull from and fetch
Dean Troyer50cda692014-07-25 11:57:20 -0500524 git remote set-url origin $git_remote
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100525 git_timed fetch origin
Dean Troyerdff49a22014-01-30 15:37:40 -0600526 # remove the existing ignored files (like pyc) as they cause breakage
527 # (due to the py files having older timestamps than our pyc, so python
528 # thinks the pyc files are correct using them)
Dean Troyer50cda692014-07-25 11:57:20 -0500529 find $git_dest -name '*.pyc' -delete
Dean Troyerdff49a22014-01-30 15:37:40 -0600530
Dean Troyer50cda692014-07-25 11:57:20 -0500531 # handle git_ref accordingly to type (tag, branch)
532 if [[ -n "`git show-ref refs/tags/$git_ref`" ]]; then
533 git_update_tag $git_ref
534 elif [[ -n "`git show-ref refs/heads/$git_ref`" ]]; then
535 git_update_branch $git_ref
536 elif [[ -n "`git show-ref refs/remotes/origin/$git_ref`" ]]; then
537 git_update_remote_branch $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600538 else
Dean Troyer50cda692014-07-25 11:57:20 -0500539 die $LINENO "$git_ref is neither branch nor tag"
Dean Troyerdff49a22014-01-30 15:37:40 -0600540 fi
541
542 fi
543 fi
544
545 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500546 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600547 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400548 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600549}
550
Sean Daguecc524062014-10-01 09:06:43 -0400551# A variation on git clone that lets us specify a project by it's
552# actual name, like oslo.config. This is exceptionally useful in the
553# library installation case
554function git_clone_by_name {
555 local name=$1
556 local repo=${GITREPO[$name]}
557 local dir=${GITDIR[$name]}
558 local branch=${GITBRANCH[$name]}
559 git_clone $repo $dir $branch
560}
561
562
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100563# git can sometimes get itself infinitely stuck with transient network
564# errors or other issues with the remote end. This wraps git in a
565# timeout/retry loop and is intended to watch over non-local git
566# processes that might hang. GIT_TIMEOUT, if set, is passed directly
567# to timeout(1); otherwise the default value of 0 maintains the status
568# quo of waiting forever.
569# usage: git_timed <git-command>
Ian Wienandaee18c72014-02-21 15:35:08 +1100570function git_timed {
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100571 local count=0
572 local timeout=0
573
574 if [[ -n "${GIT_TIMEOUT}" ]]; then
575 timeout=${GIT_TIMEOUT}
576 fi
577
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +0900578 time_start "git_timed"
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100579 until timeout -s SIGINT ${timeout} git "$@"; do
580 # 124 is timeout(1)'s special return code when it reached the
581 # timeout; otherwise assume fatal failure
582 if [[ $? -ne 124 ]]; then
583 die $LINENO "git call failed: [git $@]"
584 fi
585
586 count=$(($count + 1))
Sean Daguee4af9292015-04-28 08:57:57 -0400587 warn $LINENO "timeout ${count} for git call: [git $@]"
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100588 if [ $count -eq 3 ]; then
589 die $LINENO "Maximum of 3 git retries reached"
590 fi
591 sleep 5
592 done
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +0900593 time_stop "git_timed"
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100594}
595
Dean Troyerdff49a22014-01-30 15:37:40 -0600596# git update using reference as a branch.
597# git_update_branch ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100598function git_update_branch {
Dean Troyer50cda692014-07-25 11:57:20 -0500599 local git_branch=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600600
Dean Troyer50cda692014-07-25 11:57:20 -0500601 git checkout -f origin/$git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600602 # a local branch might not exist
Dean Troyer50cda692014-07-25 11:57:20 -0500603 git branch -D $git_branch || true
604 git checkout -b $git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600605}
606
607# git update using reference as a branch.
608# git_update_remote_branch ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100609function git_update_remote_branch {
Dean Troyer50cda692014-07-25 11:57:20 -0500610 local git_branch=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600611
Dean Troyer50cda692014-07-25 11:57:20 -0500612 git checkout -b $git_branch -t origin/$git_branch
Dean Troyerdff49a22014-01-30 15:37:40 -0600613}
614
615# git update using reference as a tag. Be careful editing source at that repo
616# as working copy will be in a detached mode
617# git_update_tag ref
Ian Wienandaee18c72014-02-21 15:35:08 +1100618function git_update_tag {
Dean Troyer50cda692014-07-25 11:57:20 -0500619 local git_tag=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600620
Dean Troyer50cda692014-07-25 11:57:20 -0500621 git tag -d $git_tag
Dean Troyerdff49a22014-01-30 15:37:40 -0600622 # fetching given tag only
Dean Troyer50cda692014-07-25 11:57:20 -0500623 git_timed fetch origin tag $git_tag
624 git checkout -f $git_tag
Dean Troyerdff49a22014-01-30 15:37:40 -0600625}
626
627
628# OpenStack Functions
629# ===================
630
631# Get the default value for HOST_IP
632# get_default_host_ip fixed_range floating_range host_ip_iface host_ip
Ian Wienandaee18c72014-02-21 15:35:08 +1100633function get_default_host_ip {
Dean Troyerdff49a22014-01-30 15:37:40 -0600634 local fixed_range=$1
635 local floating_range=$2
636 local host_ip_iface=$3
637 local host_ip=$4
Brian Haley180f5eb2015-06-16 13:14:31 -0400638 local af=$5
Dean Troyerdff49a22014-01-30 15:37:40 -0600639
Dean Troyerdff49a22014-01-30 15:37:40 -0600640 # Search for an IP unless an explicit is set by ``HOST_IP`` environment variable
641 if [ -z "$host_ip" -o "$host_ip" == "dhcp" ]; then
642 host_ip=""
Andreas Scheuringa3430272015-03-09 16:55:32 +0100643 # Find the interface used for the default route
Brian Haley180f5eb2015-06-16 13:14:31 -0400644 host_ip_iface=${host_ip_iface:-$(ip -f $af route | awk '/default/ {print $5}' | head -1)}
Ian Wienandada886d2015-10-07 14:06:26 +1100645 local host_ips
646 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 -0500647 local ip
648 for ip in $host_ips; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600649 # Attempt to filter out IP addresses that are part of the fixed and
650 # floating range. Note that this method only works if the ``netaddr``
651 # python library is installed. If it is not installed, an error
652 # will be printed and the first IP from the interface will be used.
653 # If that is not correct set ``HOST_IP`` in ``localrc`` to the correct
654 # address.
Brian Haley180f5eb2015-06-16 13:14:31 -0400655 if [[ "$af" == "inet6" ]]; then
656 host_ip=$ip
657 break;
658 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500659 if ! (address_in_net $ip $fixed_range || address_in_net $ip $floating_range); then
660 host_ip=$ip
Dean Troyerdff49a22014-01-30 15:37:40 -0600661 break;
662 fi
663 done
664 fi
665 echo $host_ip
666}
667
Attila Fazekasf71b5002014-05-28 09:52:22 +0200668# Generates hex string from ``size`` byte of pseudo random data
669# generate_hex_string size
670function generate_hex_string {
671 local size=$1
672 hexdump -n "$size" -v -e '/1 "%02x"' /dev/urandom
673}
674
Dean Troyerdff49a22014-01-30 15:37:40 -0600675# Grab a numbered field from python prettytable output
676# Fields are numbered starting with 1
677# Reverse syntax is supported: -1 is the last field, -2 is second to last, etc.
678# get_field field-number
Ian Wienandaee18c72014-02-21 15:35:08 +1100679function get_field {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500680 local data field
Dean Troyerdff49a22014-01-30 15:37:40 -0600681 while read data; do
682 if [ "$1" -lt 0 ]; then
683 field="(\$(NF$1))"
684 else
685 field="\$$(($1 + 1))"
686 fi
687 echo "$data" | awk -F'[ \t]*\\|[ \t]*' "{print $field}"
688 done
689}
690
yuntongjinf26deea2015-02-28 10:50:34 +0800691# install default policy
692# copy over a default policy.json and policy.d for projects
693function install_default_policy {
694 local project=$1
Ian Wienandada886d2015-10-07 14:06:26 +1100695 local project_uc
696 project_uc=$(echo $1|tr a-z A-Z)
yuntongjinf26deea2015-02-28 10:50:34 +0800697 local conf_dir="${project_uc}_CONF_DIR"
698 # eval conf dir to get the variable
699 conf_dir="${!conf_dir}"
700 local project_dir="${project_uc}_DIR"
701 # eval project dir to get the variable
702 project_dir="${!project_dir}"
703 local sample_conf_dir="${project_dir}/etc/${project}"
704 local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
705
706 # first copy any policy.json
707 cp -p $sample_conf_dir/policy.json $conf_dir
708 # then optionally copy over policy.d
709 if [[ -d $sample_policy_dir ]]; then
710 cp -r $sample_policy_dir $conf_dir/policy.d
711 fi
712}
713
Dean Troyerdff49a22014-01-30 15:37:40 -0600714# Add a policy to a policy.json file
715# Do nothing if the policy already exists
716# ``policy_add policy_file policy_name policy_permissions``
Ian Wienandaee18c72014-02-21 15:35:08 +1100717function policy_add {
Dean Troyerdff49a22014-01-30 15:37:40 -0600718 local policy_file=$1
719 local policy_name=$2
720 local policy_perm=$3
721
722 if grep -q ${policy_name} ${policy_file}; then
723 echo "Policy ${policy_name} already exists in ${policy_file}"
724 return
725 fi
726
727 # Add a terminating comma to policy lines without one
728 # Remove the closing '}' and all lines following to the end-of-file
Ian Wienandada886d2015-10-07 14:06:26 +1100729 local tmpfile
730 tmpfile=$(mktemp)
Dean Troyerdff49a22014-01-30 15:37:40 -0600731 uniq ${policy_file} | sed -e '
732 s/]$/],/
733 /^[}]/,$d
734 ' > ${tmpfile}
735
736 # Append policy and closing brace
737 echo " \"${policy_name}\": ${policy_perm}" >>${tmpfile}
738 echo "}" >>${tmpfile}
739
740 mv ${tmpfile} ${policy_file}
741}
742
Alistair Coles24779f62014-10-15 18:57:59 +0100743# Gets or creates a domain
744# Usage: get_or_create_domain <name> <description>
745function get_or_create_domain {
Ian Wienand11d276c2015-07-02 09:34:34 +1000746 local domain_id
Alistair Coles24779f62014-10-15 18:57:59 +0100747 # Gets domain id
Ian Wienand11d276c2015-07-02 09:34:34 +1000748 domain_id=$(
Alistair Coles24779f62014-10-15 18:57:59 +0100749 # Gets domain id
Steve Martinelli050a0d52015-09-06 22:03:54 +0000750 openstack domain show $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100751 -f value -c id 2>/dev/null ||
752 # Creates new domain
Steve Martinelli050a0d52015-09-06 22:03:54 +0000753 openstack domain create $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100754 --description "$2" \
755 -f value -c id
756 )
757 echo $domain_id
758}
759
Steve Martinellib74e01c2014-12-18 01:35:35 -0500760# Gets or creates group
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000761# Usage: get_or_create_group <groupname> <domain> [<description>]
Steve Martinellib74e01c2014-12-18 01:35:35 -0500762function get_or_create_group {
Steve Martinellib74e01c2014-12-18 01:35:35 -0500763 local desc="${3:-}"
Ian Wienand11d276c2015-07-02 09:34:34 +1000764 local group_id
Steve Martinellib74e01c2014-12-18 01:35:35 -0500765 # Gets group id
Ian Wienand11d276c2015-07-02 09:34:34 +1000766 group_id=$(
Steve Martinellib74e01c2014-12-18 01:35:35 -0500767 # Creates new group with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000768 openstack group create $1 \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000769 --domain $2 --description "$desc" --or-show \
Steve Martinellib74e01c2014-12-18 01:35:35 -0500770 -f value -c id
771 )
772 echo $group_id
773}
774
Bartosz Górski0abde392014-02-28 14:15:19 +0100775# Gets or creates user
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000776# Usage: get_or_create_user <username> <password> <domain> [<email>]
Bartosz Górski0abde392014-02-28 14:15:19 +0100777function get_or_create_user {
Ian Wienand11d276c2015-07-02 09:34:34 +1000778 local user_id
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000779 if [[ ! -z "$4" ]]; then
780 local email="--email=$4"
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200781 else
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500782 local email=""
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200783 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100784 # Gets user id
Ian Wienand11d276c2015-07-02 09:34:34 +1000785 user_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500786 # Creates new user with --or-show
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000787 openstack user create \
Bartosz Górski0abde392014-02-28 14:15:19 +0100788 $1 \
789 --password "$2" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000790 --domain=$3 \
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500791 $email \
Steve Martinelli245daa22014-11-14 02:17:22 -0500792 --or-show \
Bartosz Górski0abde392014-02-28 14:15:19 +0100793 -f value -c id
794 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500795 echo $user_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100796}
797
798# Gets or creates project
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000799# Usage: get_or_create_project <name> <domain>
Bartosz Górski0abde392014-02-28 14:15:19 +0100800function get_or_create_project {
Ian Wienand11d276c2015-07-02 09:34:34 +1000801 local project_id
802 project_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500803 # Creates new project with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000804 openstack project create $1 \
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000805 --domain=$2 \
806 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100807 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500808 echo $project_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100809}
810
811# Gets or creates role
812# Usage: get_or_create_role <name>
813function get_or_create_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000814 local role_id
815 role_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500816 # Creates role with --or-show
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000817 openstack role create $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000818 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100819 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500820 echo $role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100821}
822
Jamie Lennox9b215db2015-02-10 18:19:57 +1100823# Gets or adds user role to project
824# Usage: get_or_add_user_project_role <role> <user> <project>
825function get_or_add_user_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000826 local user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100827 # Gets user role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000828 user_role_id=$(openstack role list \
Steve Martinelli5541a612015-01-19 15:58:49 -0500829 --user $2 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100830 --column "ID" \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000831 --project $3 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100832 --column "Name" \
833 | grep " $1 " | get_field 1)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500834 if [[ -z "$user_role_id" ]]; then
Roxana Gherle50821be2015-09-22 10:52:46 -0700835 # Adds role to user and get it
836 openstack role add $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100837 --user $2 \
Steve Martinelli050a0d52015-09-06 22:03:54 +0000838 --project $3
Roxana Gherle50821be2015-09-22 10:52:46 -0700839 user_role_id=$(openstack role list \
840 --user $2 \
Roxana Gherle50821be2015-09-22 10:52:46 -0700841 --column "ID" \
842 --project $3 \
843 --column "Name" \
844 | grep " $1 " | get_field 1)
Bartosz Górski0abde392014-02-28 14:15:19 +0100845 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500846 echo $user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100847}
848
Steve Martinelli4ce859a2015-12-20 01:27:30 -0500849# Gets or adds user role to domain
850# Usage: get_or_add_user_domain_role <role> <user> <domain>
851function get_or_add_user_domain_role {
852 local user_role_id
853 # Gets user role id
854 user_role_id=$(openstack role list \
855 --user $2 \
856 --column "ID" \
857 --domain $3 \
858 --column "Name" \
859 | grep " $1 " | get_field 1)
860 if [[ -z "$user_role_id" ]]; then
861 # Adds role to user and get it
862 openstack role add $1 \
863 --user $2 \
864 --domain $3
865 user_role_id=$(openstack role list \
866 --user $2 \
867 --column "ID" \
868 --domain $3 \
869 --column "Name" \
870 | grep " $1 " | get_field 1)
871 fi
872 echo $user_role_id
873}
874
Roxana Gherle59c63772015-09-09 18:22:31 -0700875# Gets or adds user role to domain
876# Usage: get_or_add_user_domain_role <role> <user> <domain>
877function get_or_add_user_domain_role {
878 local user_role_id
879 # Gets user role id
880 user_role_id=$(openstack role list \
881 --user $2 \
882 --os-url=$KEYSTONE_SERVICE_URI_V3 \
883 --os-identity-api-version=3 \
884 --column "ID" \
885 --domain $3 \
886 --column "Name" \
887 | grep " $1 " | get_field 1)
888 if [[ -z "$user_role_id" ]]; then
889 # Adds role to user and get it
890 openstack role add $1 \
891 --user $2 \
892 --domain $3 \
893 --os-url=$KEYSTONE_SERVICE_URI_V3 \
894 --os-identity-api-version=3
895 user_role_id=$(openstack role list \
896 --user $2 \
897 --os-url=$KEYSTONE_SERVICE_URI_V3 \
898 --os-identity-api-version=3 \
899 --column "ID" \
900 --domain $3 \
901 --column "Name" \
902 | grep " $1 " | get_field 1)
903 fi
904 echo $user_role_id
905}
906
Steve Martinelli4599fd12015-03-12 21:30:58 -0400907# Gets or adds group role to project
908# Usage: get_or_add_group_project_role <role> <group> <project>
909function get_or_add_group_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000910 local group_role_id
Steve Martinelli4599fd12015-03-12 21:30:58 -0400911 # Gets group role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000912 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400913 --group $2 \
914 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000915 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400916 if [[ -z "$group_role_id" ]]; then
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000917 # Adds role to group and get it
918 openstack role add $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000919 --group $2 \
920 --project $3
921 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400922 --group $2 \
923 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000924 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400925 fi
926 echo $group_role_id
927}
928
Bartosz Górski0abde392014-02-28 14:15:19 +0100929# Gets or creates service
930# Usage: get_or_create_service <name> <type> <description>
931function get_or_create_service {
Ian Wienand11d276c2015-07-02 09:34:34 +1000932 local service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100933 # Gets service id
Ian Wienand11d276c2015-07-02 09:34:34 +1000934 service_id=$(
Bartosz Górski0abde392014-02-28 14:15:19 +0100935 # Gets service id
Jamie Lennoxaedb8b92015-07-02 17:39:07 +1000936 openstack service show $2 -f value -c id 2>/dev/null ||
Bartosz Górski0abde392014-02-28 14:15:19 +0100937 # Creates new service if not exists
938 openstack service create \
Steve Martinelli789af5c2015-01-19 16:11:44 -0500939 $2 \
940 --name $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100941 --description="$3" \
942 -f value -c id
943 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500944 echo $service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100945}
946
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000947# Create an endpoint with a specific interface
948# Usage: _get_or_create_endpoint_with_interface <service> <interface> <url> <region>
949function _get_or_create_endpoint_with_interface {
Ian Wienand11d276c2015-07-02 09:34:34 +1000950 local endpoint_id
951 endpoint_id=$(openstack endpoint list \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000952 --service $1 \
953 --interface $2 \
954 --region $4 \
Daniel Gonzalez0ec80802015-10-30 14:25:41 +0100955 -c ID -f value)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500956 if [[ -z "$endpoint_id" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100957 # Creates new endpoint
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500958 endpoint_id=$(openstack endpoint create \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000959 $1 $2 $3 --region $4 -f value -c id)
Bartosz Górski0abde392014-02-28 14:15:19 +0100960 fi
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000961
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500962 echo $endpoint_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100963}
Dean Troyerdff49a22014-01-30 15:37:40 -0600964
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000965# Gets or creates endpoint
966# Usage: get_or_create_endpoint <service> <region> <publicurl> <adminurl> <internalurl>
967function get_or_create_endpoint {
968 # NOTE(jamielennnox): when converting to v3 endpoint creation we go from
969 # creating one endpoint with multiple urls to multiple endpoints each with
970 # a different interface. To maintain the existing function interface we
971 # create 3 endpoints and return the id of the public one. In reality
972 # returning the public id will not make a lot of difference as there are no
973 # scenarios currently that use the returned id. Ideally this behaviour
974 # should be pushed out to the service setups and let them create the
975 # endpoints they need.
Ian Wienandada886d2015-10-07 14:06:26 +1100976 local public_id
977 public_id=$(_get_or_create_endpoint_with_interface $1 public $3 $2)
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000978 _get_or_create_endpoint_with_interface $1 admin $4 $2
979 _get_or_create_endpoint_with_interface $1 internal $5 $2
980
981 # return the public id to indicate success, and this is the endpoint most likely wanted
982 echo $public_id
983}
984
985# Get a URL from the identity service
986# Usage: get_endpoint_url <service> <interface>
987function get_endpoint_url {
988 echo $(openstack endpoint list \
989 --service $1 --interface $2 \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000990 -c URL -f value)
991}
992
Jim Rollenhagen47367072015-12-10 14:24:00 +0000993# check if we are using ironic with hardware
994# TODO(jroll) this is a kludge left behind when ripping ironic code
995# out of tree, as it is used by nova and neutron.
996# figure out a way to refactor nova/neutron code to eliminate this
997function is_ironic_hardware {
Lucas Alvares Gomes8a4dea22016-02-18 15:52:22 +0000998 is_service_enabled ironic && [[ "$IRONIC_IS_HARDWARE" == "True" ]] && return 0
Jim Rollenhagen47367072015-12-10 14:24:00 +0000999 return 1
1000}
1001
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001002
Dean Troyerdff49a22014-01-30 15:37:40 -06001003# Package Functions
1004# =================
1005
1006# _get_package_dir
Ian Wienandaee18c72014-02-21 15:35:08 +11001007function _get_package_dir {
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001008 local base_dir=$1
Dean Troyerdff49a22014-01-30 15:37:40 -06001009 local pkg_dir
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001010
1011 if [[ -z "$base_dir" ]]; then
1012 base_dir=$FILES
1013 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001014 if is_ubuntu; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001015 pkg_dir=$base_dir/debs
Dean Troyerdff49a22014-01-30 15:37:40 -06001016 elif is_fedora; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001017 pkg_dir=$base_dir/rpms
Dean Troyerdff49a22014-01-30 15:37:40 -06001018 elif is_suse; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001019 pkg_dir=$base_dir/rpms-suse
Dean Troyerdff49a22014-01-30 15:37:40 -06001020 else
1021 exit_distro_not_supported "list of packages"
1022 fi
1023 echo "$pkg_dir"
1024}
1025
Sean Dague88ee8ce2015-12-02 07:47:31 -05001026# Wrapper for ``apt-get update`` to try multiple times on the update
1027# to address bad package mirrors (which happen all the time).
1028function apt_get_update {
1029 # only do this once per run
1030 if [[ "$REPOS_UPDATED" == "True" && "$RETRY_UPDATE" != "True" ]]; then
1031 return
1032 fi
1033
1034 # bail if we are offline
1035 [[ "$OFFLINE" = "True" ]] && return
1036
1037 local sudo="sudo"
1038 [[ "$(id -u)" = "0" ]] && sudo="env"
1039
1040 # time all the apt operations
1041 time_start "apt-get-update"
1042
1043 local proxies="http_proxy=${http_proxy:-} https_proxy=${https_proxy:-} no_proxy=${no_proxy:-} "
1044 local update_cmd="$sudo $proxies apt-get update"
1045 if ! timeout 300 sh -c "while ! $update_cmd; do sleep 30; done"; then
1046 die $LINENO "Failed to update apt repos, we're dead now"
1047 fi
1048
1049 REPOS_UPDATED=True
1050 # stop the clock
1051 time_stop "apt-get-update"
1052}
1053
Dean Troyerdff49a22014-01-30 15:37:40 -06001054# Wrapper for ``apt-get`` to set cache and proxy environment variables
1055# Uses globals ``OFFLINE``, ``*_proxy``
1056# apt_get operation package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001057function apt_get {
Federico Ressie208d062015-11-21 11:15:39 +00001058 local xtrace result
Ian Wienand433a9b12015-10-07 13:29:31 +11001059 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -05001060 set +o xtrace
1061
Dean Troyerdff49a22014-01-30 15:37:40 -06001062 [[ "$OFFLINE" = "True" || -z "$@" ]] && return
1063 local sudo="sudo"
1064 [[ "$(id -u)" = "0" ]] && sudo="env"
Sean Dague45917cc2014-02-24 16:09:14 -05001065
Sean Dague95c33d52015-10-07 11:05:59 -04001066 # time all the apt operations
1067 time_start "apt-get"
1068
Sean Dague45917cc2014-02-24 16:09:14 -05001069 $xtrace
Sean Dague53753292014-12-04 19:38:15 -05001070
Dean Troyerdff49a22014-01-30 15:37:40 -06001071 $sudo DEBIAN_FRONTEND=noninteractive \
Sean Dague53753292014-12-04 19:38:15 -05001072 http_proxy=${http_proxy:-} https_proxy=${https_proxy:-} \
1073 no_proxy=${no_proxy:-} \
John L. Villalovosf568c3a2016-01-07 19:10:50 -08001074 apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@" < /dev/null
Federico Ressie208d062015-11-21 11:15:39 +00001075 result=$?
Sean Dague95c33d52015-10-07 11:05:59 -04001076
1077 # stop the clock
1078 time_stop "apt-get"
Federico Ressie208d062015-11-21 11:15:39 +00001079 return $result
Dean Troyerdff49a22014-01-30 15:37:40 -06001080}
1081
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001082function _parse_package_files {
1083 local files_to_parse=$@
Dean Troyerdff49a22014-01-30 15:37:40 -06001084
Dean Troyerdff49a22014-01-30 15:37:40 -06001085 if [[ -z "$DISTRO" ]]; then
1086 GetDistro
1087 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001088
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001089 for fname in ${files_to_parse}; do
Dean Troyerdff49a22014-01-30 15:37:40 -06001090 local OIFS line package distros distro
1091 [[ -e $fname ]] || continue
1092
1093 OIFS=$IFS
1094 IFS=$'\n'
1095 for line in $(<${fname}); do
1096 if [[ $line =~ "NOPRIME" ]]; then
1097 continue
1098 fi
1099
Ian Wienand1ff75ff2016-02-19 14:28:37 +11001100 # Assume we want this package; free-form
1101 # comments allowed after a #
1102 package=${line%%#*}
Dean Troyerdff49a22014-01-30 15:37:40 -06001103 inst_pkg=1
1104
1105 # Look for # dist:xxx in comment
1106 if [[ $line =~ (.*)#.*dist:([^ ]*) ]]; then
1107 # We are using BASH regexp matching feature.
1108 package=${BASH_REMATCH[1]}
1109 distros=${BASH_REMATCH[2]}
Atsushi SAKAI33c9a672015-11-12 19:50:00 +09001110 # In bash ${VAR,,} will lowercase VAR
Dean Troyerdff49a22014-01-30 15:37:40 -06001111 # Look for a match in the distro list
1112 if [[ ! ${distros,,} =~ ${DISTRO,,} ]]; then
1113 # If no match then skip this package
1114 inst_pkg=0
1115 fi
1116 fi
1117
Dean Troyerdff49a22014-01-30 15:37:40 -06001118 if [[ $inst_pkg = 1 ]]; then
1119 echo $package
1120 fi
1121 done
1122 IFS=$OIFS
1123 done
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001124}
1125
1126# get_packages() collects a list of package names of any type from the
1127# prerequisite files in ``files/{debs|rpms}``. The list is intended
1128# to be passed to a package installer such as apt or yum.
1129#
1130# Only packages required for the services in 1st argument will be
1131# included. Two bits of metadata are recognized in the prerequisite files:
1132#
1133# - ``# NOPRIME`` defers installation to be performed later in `stack.sh`
1134# - ``# dist:DISTRO`` or ``dist:DISTRO1,DISTRO2`` limits the selection
1135# of the package to the distros listed. The distro names are case insensitive.
1136function get_packages {
Ian Wienand433a9b12015-10-07 13:29:31 +11001137 local xtrace
1138 xtrace=$(set +o | grep xtrace)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001139 set +o xtrace
1140 local services=$@
Ian Wienandada886d2015-10-07 14:06:26 +11001141 local package_dir
1142 package_dir=$(_get_package_dir)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001143 local file_to_parse=""
1144 local service=""
1145
Ian Wienand7d515b52015-11-09 15:04:32 +11001146 if [ $# -ne 1 ]; then
1147 die $LINENO "get_packages takes a single, comma-separated argument"
1148 fi
1149
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001150 if [[ -z "$package_dir" ]]; then
1151 echo "No package directory supplied"
1152 return 1
1153 fi
1154 for service in ${services//,/ }; do
1155 # Allow individual services to specify dependencies
1156 if [[ -e ${package_dir}/${service} ]]; then
1157 file_to_parse="${file_to_parse} ${package_dir}/${service}"
1158 fi
1159 # NOTE(sdague) n-api needs glance for now because that's where
1160 # glance client is
1161 if [[ $service == n-api ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001162 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001163 file_to_parse="${file_to_parse} ${package_dir}/nova"
1164 fi
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001165 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001166 file_to_parse="${file_to_parse} ${package_dir}/glance"
1167 fi
1168 elif [[ $service == c-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001169 if [[ ! $file_to_parse =~ $package_dir/cinder ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001170 file_to_parse="${file_to_parse} ${package_dir}/cinder"
1171 fi
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001172 elif [[ $service == s-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001173 if [[ ! $file_to_parse =~ $package_dir/swift ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001174 file_to_parse="${file_to_parse} ${package_dir}/swift"
1175 fi
1176 elif [[ $service == n-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001177 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001178 file_to_parse="${file_to_parse} ${package_dir}/nova"
1179 fi
1180 elif [[ $service == g-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001181 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001182 file_to_parse="${file_to_parse} ${package_dir}/glance"
1183 fi
1184 elif [[ $service == key* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001185 if [[ ! $file_to_parse =~ $package_dir/keystone ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001186 file_to_parse="${file_to_parse} ${package_dir}/keystone"
1187 fi
1188 elif [[ $service == q-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001189 if [[ ! $file_to_parse =~ $package_dir/neutron ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001190 file_to_parse="${file_to_parse} ${package_dir}/neutron"
1191 fi
1192 elif [[ $service == ir-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001193 if [[ ! $file_to_parse =~ $package_dir/ironic ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001194 file_to_parse="${file_to_parse} ${package_dir}/ironic"
1195 fi
1196 fi
1197 done
1198 echo "$(_parse_package_files $file_to_parse)"
1199 $xtrace
1200}
1201
1202# get_plugin_packages() collects a list of package names of any type from a
1203# plugin's prerequisite files in ``$PLUGIN/devstack/files/{debs|rpms}``. The
1204# list is intended to be passed to a package installer such as apt or yum.
1205#
1206# Only packages required for enabled and collected plugins will included.
1207#
Dean Troyerdc97cb72015-03-28 08:20:50 -05001208# The same metadata used in the main DevStack prerequisite files may be used
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001209# in these prerequisite files, see get_packages() for more info.
1210function get_plugin_packages {
Ian Wienand433a9b12015-10-07 13:29:31 +11001211 local xtrace
1212 xtrace=$(set +o | grep xtrace)
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001213 set +o xtrace
1214 local files_to_parse=""
1215 local package_dir=""
1216 for plugin in ${DEVSTACK_PLUGINS//,/ }; do
Ian Wienand7ae97292016-02-16 14:50:53 +11001217 package_dir="$(_get_package_dir ${GITDIR[$plugin]}/devstack/files)"
Dmitry Tantsur5979f472016-01-03 18:08:14 +01001218 files_to_parse+=" $package_dir/$plugin"
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001219 done
1220 echo "$(_parse_package_files $files_to_parse)"
Sean Dague45917cc2014-02-24 16:09:14 -05001221 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001222}
1223
1224# Distro-agnostic package installer
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001225# Uses globals ``NO_UPDATE_REPOS``, ``REPOS_UPDATED``, ``RETRY_UPDATE``
Dean Troyerdff49a22014-01-30 15:37:40 -06001226# install_package package [package ...]
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001227function update_package_repo {
Sean Dague53753292014-12-04 19:38:15 -05001228 NO_UPDATE_REPOS=${NO_UPDATE_REPOS:-False}
1229 REPOS_UPDATED=${REPOS_UPDATED:-False}
1230 RETRY_UPDATE=${RETRY_UPDATE:-False}
1231
Paul Linchpiner9e179742014-07-13 22:23:00 -07001232 if [[ "$NO_UPDATE_REPOS" = "True" ]]; then
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001233 return 0
1234 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001235
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001236 if is_ubuntu; then
Sean Dague88ee8ce2015-12-02 07:47:31 -05001237 apt_get_update
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001238 fi
1239}
1240
1241function real_install_package {
1242 if is_ubuntu; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001243 apt_get install "$@"
1244 elif is_fedora; then
1245 yum_install "$@"
1246 elif is_suse; then
1247 zypper_install "$@"
1248 else
1249 exit_distro_not_supported "installing packages"
1250 fi
1251}
1252
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001253# Distro-agnostic package installer
1254# install_package package [package ...]
1255function install_package {
1256 update_package_repo
Federico Ressiecc1f412015-12-28 15:14:13 +01001257 if ! real_install_package "$@"; then
1258 RETRY_UPDATE=True update_package_repo && real_install_package "$@"
1259 fi
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001260}
1261
Dean Troyerdff49a22014-01-30 15:37:40 -06001262# Distro-agnostic function to tell if a package is installed
1263# is_package_installed package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001264function is_package_installed {
Dean Troyerdff49a22014-01-30 15:37:40 -06001265 if [[ -z "$@" ]]; then
1266 return 1
1267 fi
1268
1269 if [[ -z "$os_PACKAGE" ]]; then
1270 GetOSVersion
1271 fi
1272
1273 if [[ "$os_PACKAGE" = "deb" ]]; then
1274 dpkg -s "$@" > /dev/null 2> /dev/null
1275 elif [[ "$os_PACKAGE" = "rpm" ]]; then
1276 rpm --quiet -q "$@"
1277 else
1278 exit_distro_not_supported "finding if a package is installed"
1279 fi
1280}
1281
1282# Distro-agnostic package uninstaller
1283# uninstall_package package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001284function uninstall_package {
Dean Troyerdff49a22014-01-30 15:37:40 -06001285 if is_ubuntu; then
1286 apt_get purge "$@"
1287 elif is_fedora; then
Ian Wienand36298ee2015-02-04 10:29:31 +11001288 sudo ${YUM:-yum} remove -y "$@" ||:
Dean Troyerdff49a22014-01-30 15:37:40 -06001289 elif is_suse; then
1290 sudo zypper rm "$@"
1291 else
1292 exit_distro_not_supported "uninstalling packages"
1293 fi
1294}
1295
1296# Wrapper for ``yum`` to set proxy environment variables
Daniel P. Berrange63d25d92014-12-09 15:21:22 +00001297# Uses globals ``OFFLINE``, ``*_proxy``, ``YUM``
Dean Troyerdff49a22014-01-30 15:37:40 -06001298# yum_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001299function yum_install {
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00001300 local result parse_yum_result
1301
Dean Troyerdff49a22014-01-30 15:37:40 -06001302 [[ "$OFFLINE" = "True" ]] && return
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00001303
1304 time_start "yum_install"
1305
1306 # Warning: this would not work if yum output message
1307 # have been translated to another language
1308 parse_yum_result='\
1309 BEGIN { result=0 }\
1310 /^YUM_FAILED/ { exit $2 }\
1311 /^No package/ { result=1 }\
1312 //{ print }\
1313 END { exit result }'
Ian Wienandb27f16d2014-02-28 14:29:02 +11001314
1315 # The manual check for missing packages is because yum -y assumes
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00001316 # missing packages are OK.
1317 # See https://bugzilla.redhat.com/show_bug.cgi?id=965567
1318 (sudo_with_proxies "${YUM:-yum}" install -y "$@" 2>&1 || echo YUM_FAILED $?) \
1319 | awk "$parse_yum_result"
1320 result=$?
Ian Wienandb27f16d2014-02-28 14:29:02 +11001321
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00001322 if [ "$result" != 0 ]; then
1323 echo $LINENO "${YUM:-yum}" install failure: $result
Ian Wienandb27f16d2014-02-28 14:29:02 +11001324 fi
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00001325
1326 time_stop "yum_install"
1327
1328 return "$result"
Dean Troyerdff49a22014-01-30 15:37:40 -06001329}
1330
1331# zypper wrapper to set arguments correctly
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001332# Uses globals ``OFFLINE``, ``*_proxy``
Dean Troyerdff49a22014-01-30 15:37:40 -06001333# zypper_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001334function zypper_install {
Dean Troyerdff49a22014-01-30 15:37:40 -06001335 [[ "$OFFLINE" = "True" ]] && return
1336 local sudo="sudo"
1337 [[ "$(id -u)" = "0" ]] && sudo="env"
Ian Wienandfdf00f22015-03-13 11:50:02 +11001338 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}" \
1339 no_proxy="${no_proxy:-}" \
Dean Troyerdff49a22014-01-30 15:37:40 -06001340 zypper --non-interactive install --auto-agree-with-licenses "$@"
1341}
1342
1343
1344# Process Functions
1345# =================
1346
1347# _run_process() is designed to be backgrounded by run_process() to simulate a
1348# fork. It includes the dirty work of closing extra filehandles and preparing log
1349# files to produce the same logs as screen_it(). The log filename is derived
Dean Troyerdde41d02014-12-09 17:47:57 -06001350# from the service name.
1351# Uses globals ``CURRENT_LOG_TIME``, ``LOGDIR``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001352# If an optional group is provided sg will be used to set the group of
1353# the command.
1354# _run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001355function _run_process {
Sean Dague6e137ab2015-04-29 08:22:24 -04001356 # disable tracing through the exec redirects, it's just confusing in the logs.
1357 xtrace=$(set +o | grep xtrace)
1358 set +o xtrace
1359
Dean Troyerdff49a22014-01-30 15:37:40 -06001360 local service=$1
1361 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001362 local group=$3
Dean Troyerdff49a22014-01-30 15:37:40 -06001363
1364 # Undo logging redirections and close the extra descriptors
1365 exec 1>&3
1366 exec 2>&3
1367 exec 3>&-
1368 exec 6>&-
1369
Philipp Marekaf0801d2015-12-09 13:51:56 +01001370 local logfile="${service}.log.${CURRENT_LOG_TIME}"
1371 local real_logfile="${LOGDIR}/${logfile}"
Dean Troyerdde41d02014-12-09 17:47:57 -06001372 if [[ -n ${LOGDIR} ]]; then
1373 exec 1>&"$real_logfile" 2>&1
Philipp Marekaf0801d2015-12-09 13:51:56 +01001374 bash -c "cd '$LOGDIR' && ln -sf '$logfile' ${service}.log"
Dean Troyerdde41d02014-12-09 17:47:57 -06001375 if [[ -n ${SCREEN_LOGDIR} ]]; then
1376 # Drop the backward-compat symlink
1377 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${service}.log
1378 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001379
1380 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1381 export PYTHONUNBUFFERED=1
1382 fi
1383
Sean Dague6e137ab2015-04-29 08:22:24 -04001384 # reenable xtrace before we do *real* work
1385 $xtrace
1386
Dean Troyer3159a822014-08-27 14:13:58 -05001387 # Run under ``setsid`` to force the process to become a session and group leader.
1388 # The pid saved can be used with pkill -g to get the entire process group.
Chris Dent2f27a0e2014-09-09 13:46:02 +01001389 if [[ -n "$group" ]]; then
1390 setsid sg $group "$command" & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1391 else
1392 setsid $command & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1393 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001394
1395 # Just silently exit this process
1396 exit 0
Dean Troyerdff49a22014-01-30 15:37:40 -06001397}
1398
1399# Helper to remove the ``*.failure`` files under ``$SERVICE_DIR/$SCREEN_NAME``.
1400# This is used for ``service_check`` when all the ``screen_it`` are called finished
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001401# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001402# init_service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001403function init_service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001404 SCREEN_NAME=${SCREEN_NAME:-stack}
1405 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1406
1407 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1408 mkdir -p "$SERVICE_DIR/$SCREEN_NAME"
1409 fi
1410
1411 rm -f "$SERVICE_DIR/$SCREEN_NAME"/*.failure
1412}
1413
1414# Find out if a process exists by partial name.
1415# is_running name
Ian Wienandaee18c72014-02-21 15:35:08 +11001416function is_running {
Dean Troyerdff49a22014-01-30 15:37:40 -06001417 local name=$1
1418 ps auxw | grep -v grep | grep ${name} > /dev/null
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001419 local exitcode=$?
Dean Troyerdff49a22014-01-30 15:37:40 -06001420 # some times I really hate bash reverse binary logic
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001421 return $exitcode
Dean Troyerdff49a22014-01-30 15:37:40 -06001422}
1423
Dean Troyer3159a822014-08-27 14:13:58 -05001424# Run a single service under screen or directly
1425# If the command includes shell metachatacters (;<>*) it must be run using a shell
Chris Dent2f27a0e2014-09-09 13:46:02 +01001426# If an optional group is provided sg will be used to run the
1427# command as that group.
Tony Breeds93292902015-11-09 15:45:04 +11001428# Uses globals ``USE_SCREEN``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001429# run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001430function run_process {
Dean Troyerdff49a22014-01-30 15:37:40 -06001431 local service=$1
1432 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001433 local group=$3
Brant Knudsonedc11c22015-12-14 15:32:05 -06001434 local subservice=$4
1435
1436 local name=${subservice:-$service}
Dean Troyerdff49a22014-01-30 15:37:40 -06001437
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +09001438 time_start "run_process"
Dean Troyer3159a822014-08-27 14:13:58 -05001439 if is_service_enabled $service; then
1440 if [[ "$USE_SCREEN" = "True" ]]; then
Brant Knudsonedc11c22015-12-14 15:32:05 -06001441 screen_process "$name" "$command" "$group"
Dean Troyer3159a822014-08-27 14:13:58 -05001442 else
1443 # Spawn directly without screen
Brant Knudsonedc11c22015-12-14 15:32:05 -06001444 _run_process "$name" "$command" "$group" &
Dean Troyer3159a822014-08-27 14:13:58 -05001445 fi
1446 fi
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +09001447 time_stop "run_process"
Dean Troyerdff49a22014-01-30 15:37:40 -06001448}
1449
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001450# Helper to launch a process in a named screen
Dean Troyerdde41d02014-12-09 17:47:57 -06001451# Uses globals ``CURRENT_LOG_TIME``, ```LOGDIR``, ``SCREEN_LOGDIR``, `SCREEN_NAME``,
Tony Breeds93292902015-11-09 15:45:04 +11001452# ``SERVICE_DIR``, ``SCREEN_IS_LOGGING``
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001453# screen_process name "command-line" [group]
Chris Dent2f27a0e2014-09-09 13:46:02 +01001454# Run a command in a shell in a screen window, if an optional group
1455# is provided, use sg to set the group of the command.
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001456function screen_process {
1457 local name=$1
Dean Troyer3159a822014-08-27 14:13:58 -05001458 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001459 local group=$3
Dean Troyer3159a822014-08-27 14:13:58 -05001460
Sean Dagueea22a4f2014-06-27 15:21:41 -04001461 SCREEN_NAME=${SCREEN_NAME:-stack}
1462 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Dean Troyerdff49a22014-01-30 15:37:40 -06001463
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001464 screen -S $SCREEN_NAME -X screen -t $name
Dean Troyerdff49a22014-01-30 15:37:40 -06001465
Philipp Marekaf0801d2015-12-09 13:51:56 +01001466 local logfile="${name}.log.${CURRENT_LOG_TIME}"
1467 local real_logfile="${LOGDIR}/${logfile}"
Dean Troyerdde41d02014-12-09 17:47:57 -06001468 echo "LOGDIR: $LOGDIR"
1469 echo "SCREEN_LOGDIR: $SCREEN_LOGDIR"
1470 echo "log: $real_logfile"
1471 if [[ -n ${LOGDIR} ]]; then
Tony Breeds536b8c12015-11-09 10:05:37 +11001472 if [[ "$SCREEN_IS_LOGGING" == "True" ]]; then
1473 screen -S $SCREEN_NAME -p $name -X logfile "$real_logfile"
1474 screen -S $SCREEN_NAME -p $name -X log on
1475 fi
1476 # If logging isn't active then avoid a broken symlink
1477 touch "$real_logfile"
Philipp Marekaf0801d2015-12-09 13:51:56 +01001478 bash -c "cd '$LOGDIR' && ln -sf '$logfile' ${name}.log"
Dean Troyerdde41d02014-12-09 17:47:57 -06001479 if [[ -n ${SCREEN_LOGDIR} ]]; then
1480 # Drop the backward-compat symlink
1481 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${1}.log
1482 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001483 fi
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001484
1485 # sleep to allow bash to be ready to be send the command - we are
1486 # creating a new window in screen and then sends characters, so if
Sean Dague4d7ee092015-04-07 10:40:49 -04001487 # bash isn't running by the time we send the command, nothing
1488 # happens. This sleep was added originally to handle gate runs
1489 # where we needed this to be at least 3 seconds to pass
1490 # consistently on slow clouds. Now this is configurable so that we
1491 # can determine a reasonable value for the local case which should
1492 # be much smaller.
1493 sleep ${SCREEN_SLEEP:-3}
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001494
1495 NL=`echo -ne '\015'`
1496 # This fun command does the following:
1497 # - the passed server command is backgrounded
1498 # - the pid of the background process is saved in the usual place
1499 # - the server process is brought back to the foreground
1500 # - if the server process exits prematurely the fg command errors
1501 # and a message is written to stdout and the process failure file
1502 #
1503 # The pid saved can be used in stop_process() as a process group
1504 # id to kill off all child processes
1505 if [[ -n "$group" ]]; then
1506 command="sg $group '$command'"
1507 fi
Ian Wienandb28b2702015-04-16 08:43:43 +10001508
1509 # Append the process to the screen rc file
1510 screen_rc "$name" "$command"
1511
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001512 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 -06001513}
1514
1515# Screen rc file builder
Tony Breeds536b8c12015-11-09 10:05:37 +11001516# Uses globals ``SCREEN_NAME``, ``SCREENRC``, ``SCREEN_IS_LOGGING``
Dean Troyerdff49a22014-01-30 15:37:40 -06001517# screen_rc service "command-line"
1518function screen_rc {
1519 SCREEN_NAME=${SCREEN_NAME:-stack}
1520 SCREENRC=$TOP_DIR/$SCREEN_NAME-screenrc
1521 if [[ ! -e $SCREENRC ]]; then
1522 # Name the screen session
1523 echo "sessionname $SCREEN_NAME" > $SCREENRC
1524 # Set a reasonable statusbar
1525 echo "hardstatus alwayslastline '$SCREEN_HARDSTATUS'" >> $SCREENRC
1526 # Some distributions override PROMPT_COMMAND for the screen terminal type - turn that off
1527 echo "setenv PROMPT_COMMAND /bin/true" >> $SCREENRC
1528 echo "screen -t shell bash" >> $SCREENRC
1529 fi
1530 # If this service doesn't already exist in the screenrc file
1531 if ! grep $1 $SCREENRC 2>&1 > /dev/null; then
1532 NL=`echo -ne '\015'`
1533 echo "screen -t $1 bash" >> $SCREENRC
1534 echo "stuff \"$2$NL\"" >> $SCREENRC
1535
Tony Breeds536b8c12015-11-09 10:05:37 +11001536 if [[ -n ${LOGDIR} ]] && [[ "$SCREEN_IS_LOGGING" == "True" ]]; then
Dean Troyerdde41d02014-12-09 17:47:57 -06001537 echo "logfile ${LOGDIR}/${1}.log.${CURRENT_LOG_TIME}" >>$SCREENRC
Dean Troyerdff49a22014-01-30 15:37:40 -06001538 echo "log on" >>$SCREENRC
1539 fi
1540 fi
1541}
1542
1543# Stop a service in screen
1544# If a PID is available use it, kill the whole process group via TERM
1545# If screen is being used kill the screen window; this will catch processes
1546# that did not leave a PID behind
Tony Breeds93292902015-11-09 15:45:04 +11001547# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001548# screen_stop_service service
Dean Troyer3159a822014-08-27 14:13:58 -05001549function screen_stop_service {
1550 local service=$1
1551
Dean Troyerdff49a22014-01-30 15:37:40 -06001552 SCREEN_NAME=${SCREEN_NAME:-stack}
1553 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Dean Troyerdff49a22014-01-30 15:37:40 -06001554
Dean Troyer3159a822014-08-27 14:13:58 -05001555 if is_service_enabled $service; then
1556 # Clean up the screen window
Attila Fazekasf750a6f2015-07-01 12:17:35 +02001557 screen -S $SCREEN_NAME -p $service -X kill || true
Dean Troyer3159a822014-08-27 14:13:58 -05001558 fi
1559}
1560
1561# Stop a service process
1562# If a PID is available use it, kill the whole process group via TERM
1563# If screen is being used kill the screen window; this will catch processes
1564# that did not leave a PID behind
1565# Uses globals ``SERVICE_DIR``, ``USE_SCREEN``
1566# stop_process service
1567function stop_process {
1568 local service=$1
1569
1570 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Dean Troyer3159a822014-08-27 14:13:58 -05001571
1572 if is_service_enabled $service; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001573 # Kill via pid if we have one available
Dean Troyer3159a822014-08-27 14:13:58 -05001574 if [[ -r $SERVICE_DIR/$SCREEN_NAME/$service.pid ]]; then
1575 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid)
Dan Smithce7246a2015-04-23 09:41:06 -07001576 # oslo.service tends to stop actually shutting down
1577 # reliably in between releases because someone believes it
1578 # is dying too early due to some inflight work they
1579 # have. This is a tension. It happens often enough we're
1580 # going to just account for it in devstack and assume it
1581 # doesn't work.
1582 #
1583 # Set OSLO_SERVICE_WORKS=True to skip this block
1584 if [[ -z "$OSLO_SERVICE_WORKS" ]]; then
1585 # TODO(danms): Remove this double-kill when we have
1586 # this fixed in all services:
1587 # https://bugs.launchpad.net/oslo-incubator/+bug/1446583
1588 sleep 1
Atsushi SAKAI33c9a672015-11-12 19:50:00 +09001589 # /bin/true because pkill on a non existent process returns an error
Dan Smithce7246a2015-04-23 09:41:06 -07001590 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid) || /bin/true
1591 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001592 rm $SERVICE_DIR/$SCREEN_NAME/$service.pid
Dean Troyerdff49a22014-01-30 15:37:40 -06001593 fi
1594 if [[ "$USE_SCREEN" = "True" ]]; then
1595 # Clean up the screen window
Dean Troyer3159a822014-08-27 14:13:58 -05001596 screen_stop_service $service
Dean Troyerdff49a22014-01-30 15:37:40 -06001597 fi
1598 fi
1599}
1600
1601# Helper to get the status of each running service
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001602# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001603# service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001604function service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001605 local service
1606 local failures
1607 SCREEN_NAME=${SCREEN_NAME:-stack}
1608 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1609
1610
1611 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1612 echo "No service status directory found"
1613 return
1614 fi
1615
Wei Jiangange3340f12015-09-21 17:52:14 +08001616 # Check if there is any failure flag file under $SERVICE_DIR/$SCREEN_NAME
Sean Dague09bd7c82014-02-03 08:35:26 +09001617 # make this -o errexit safe
1618 failures=`ls "$SERVICE_DIR/$SCREEN_NAME"/*.failure 2>/dev/null || /bin/true`
Dean Troyerdff49a22014-01-30 15:37:40 -06001619
1620 for service in $failures; do
1621 service=`basename $service`
1622 service=${service%.failure}
1623 echo "Error: Service $service is not running"
1624 done
1625
1626 if [ -n "$failures" ]; then
Sean Dague12379222014-02-27 17:16:46 -05001627 die $LINENO "More details about the above errors can be found with screen, with ./rejoin-stack.sh"
Dean Troyerdff49a22014-01-30 15:37:40 -06001628 fi
1629}
1630
Chris Dent2f27a0e2014-09-09 13:46:02 +01001631# Tail a log file in a screen if USE_SCREEN is true.
Tony Breeds93292902015-11-09 15:45:04 +11001632# Uses globals ``USE_SCREEN``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001633function tail_log {
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001634 local name=$1
Chris Dent2f27a0e2014-09-09 13:46:02 +01001635 local logfile=$2
1636
Chris Dent2f27a0e2014-09-09 13:46:02 +01001637 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001638 screen_process "$name" "sudo tail -f $logfile"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001639 fi
1640}
1641
Dean Troyerdff49a22014-01-30 15:37:40 -06001642
Dean Troyer3159a822014-08-27 14:13:58 -05001643# Deprecated Functions
1644# --------------------
1645
1646# _old_run_process() is designed to be backgrounded by old_run_process() to simulate a
1647# fork. It includes the dirty work of closing extra filehandles and preparing log
1648# files to produce the same logs as screen_it(). The log filename is derived
1649# from the service name and global-and-now-misnamed ``SCREEN_LOGDIR``
1650# Uses globals ``CURRENT_LOG_TIME``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
1651# _old_run_process service "command-line"
1652function _old_run_process {
1653 local service=$1
1654 local command="$2"
1655
1656 # Undo logging redirections and close the extra descriptors
1657 exec 1>&3
1658 exec 2>&3
1659 exec 3>&-
1660 exec 6>&-
1661
1662 if [[ -n ${SCREEN_LOGDIR} ]]; then
Dean Troyerad5cc982014-12-10 16:35:32 -06001663 exec 1>&${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} 2>&1
1664 ln -sf ${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} ${SCREEN_LOGDIR}/screen-${1}.log
Dean Troyer3159a822014-08-27 14:13:58 -05001665
1666 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1667 export PYTHONUNBUFFERED=1
1668 fi
1669
1670 exec /bin/bash -c "$command"
1671 die "$service exec failure: $command"
1672}
1673
1674# old_run_process() launches a child process that closes all file descriptors and
1675# then exec's the passed in command. This is meant to duplicate the semantics
1676# of screen_it() without screen. PIDs are written to
1677# ``$SERVICE_DIR/$SCREEN_NAME/$service.pid`` by the spawned child process.
1678# old_run_process service "command-line"
1679function old_run_process {
1680 local service=$1
1681 local command="$2"
1682
1683 # Spawn the child process
1684 _old_run_process "$service" "$command" &
1685 echo $!
1686}
1687
1688# Compatibility for existing start_XXXX() functions
1689# Uses global ``USE_SCREEN``
1690# screen_it service "command-line"
1691function screen_it {
1692 if is_service_enabled $1; then
1693 # Append the service to the screen rc file
1694 screen_rc "$1" "$2"
1695
1696 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001697 screen_process "$1" "$2"
Dean Troyer3159a822014-08-27 14:13:58 -05001698 else
1699 # Spawn directly without screen
1700 old_run_process "$1" "$2" >$SERVICE_DIR/$SCREEN_NAME/$1.pid
1701 fi
1702 fi
1703}
1704
1705# Compatibility for existing stop_XXXX() functions
1706# Stop a service in screen
1707# If a PID is available use it, kill the whole process group via TERM
1708# If screen is being used kill the screen window; this will catch processes
1709# that did not leave a PID behind
1710# screen_stop service
1711function screen_stop {
1712 # Clean up the screen window
1713 stop_process $1
1714}
1715
1716
Sean Dague2c65e712014-12-18 09:44:56 -05001717# Plugin Functions
1718# =================
1719
1720DEVSTACK_PLUGINS=${DEVSTACK_PLUGINS:-""}
1721
1722# enable_plugin <name> <url> [branch]
1723#
1724# ``name`` is an arbitrary name - (aka: glusterfs, nova-docker, zaqar)
1725# ``url`` is a git url
1726# ``branch`` is a gitref. If it's not set, defaults to master
1727function enable_plugin {
1728 local name=$1
1729 local url=$2
1730 local branch=${3:-master}
1731 DEVSTACK_PLUGINS+=",$name"
1732 GITREPO[$name]=$url
1733 GITDIR[$name]=$DEST/$name
1734 GITBRANCH[$name]=$branch
1735}
1736
1737# fetch_plugins
1738#
1739# clones all plugins
1740function fetch_plugins {
1741 local plugins="${DEVSTACK_PLUGINS}"
1742 local plugin
1743
1744 # short circuit if nothing to do
1745 if [[ -z $plugins ]]; then
1746 return
1747 fi
1748
Dean Troyerdc97cb72015-03-28 08:20:50 -05001749 echo "Fetching DevStack plugins"
Sean Dague2c65e712014-12-18 09:44:56 -05001750 for plugin in ${plugins//,/ }; do
1751 git_clone_by_name $plugin
1752 done
1753}
1754
1755# load_plugin_settings
1756#
1757# Load settings from plugins in the order that they were registered
1758function load_plugin_settings {
1759 local plugins="${DEVSTACK_PLUGINS}"
1760 local plugin
1761
1762 # short circuit if nothing to do
1763 if [[ -z $plugins ]]; then
1764 return
1765 fi
1766
1767 echo "Loading plugin settings"
1768 for plugin in ${plugins//,/ }; do
1769 local dir=${GITDIR[$plugin]}
1770 # source any known settings
1771 if [[ -f $dir/devstack/settings ]]; then
1772 source $dir/devstack/settings
1773 fi
1774 done
1775}
1776
Sean Dague6e275e12015-03-26 05:54:28 -04001777# plugin_override_defaults
1778#
1779# Run an extremely early setting phase for plugins that allows default
1780# overriding of services.
1781function plugin_override_defaults {
1782 local plugins="${DEVSTACK_PLUGINS}"
1783 local plugin
1784
1785 # short circuit if nothing to do
1786 if [[ -z $plugins ]]; then
1787 return
1788 fi
1789
1790 echo "Overriding Configuration Defaults"
1791 for plugin in ${plugins//,/ }; do
1792 local dir=${GITDIR[$plugin]}
1793 # source any overrides
1794 if [[ -f $dir/devstack/override-defaults ]]; then
1795 # be really verbose that an override is happening, as it
1796 # may not be obvious if things fail later.
Atsushi SAKAI33c9a672015-11-12 19:50:00 +09001797 echo "$plugin has overridden the following defaults"
Sean Dague6e275e12015-03-26 05:54:28 -04001798 cat $dir/devstack/override-defaults
1799 source $dir/devstack/override-defaults
1800 fi
1801 done
1802}
1803
Sean Dague2c65e712014-12-18 09:44:56 -05001804# run_plugins
1805#
1806# Run the devstack/plugin.sh in all the plugin directories. These are
1807# run in registration order.
1808function run_plugins {
1809 local mode=$1
1810 local phase=$2
Bharat Kumar Kobagana441ff072015-01-08 12:26:26 +05301811
1812 local plugins="${DEVSTACK_PLUGINS}"
1813 local plugin
Sean Dague2c65e712014-12-18 09:44:56 -05001814 for plugin in ${plugins//,/ }; do
1815 local dir=${GITDIR[$plugin]}
1816 if [[ -f $dir/devstack/plugin.sh ]]; then
1817 source $dir/devstack/plugin.sh $mode $phase
1818 fi
1819 done
1820}
1821
1822function run_phase {
1823 local mode=$1
1824 local phase=$2
1825 if [[ -d $TOP_DIR/extras.d ]]; then
Dmitry Tantsur64be3212015-10-12 13:10:24 +02001826 local extra_plugin_file_name
1827 for extra_plugin_file_name in $TOP_DIR/extras.d/*.sh; do
Sean Dague41d01102015-12-03 08:12:23 -05001828 # NOTE(sdague): only process extras.d for the 3 explicitly
1829 # white listed elements in tree. We want these to move out
1830 # over time as well, but they are in tree, so we need to
1831 # manage that.
Jim Rollenhagen47367072015-12-10 14:24:00 +00001832 local exceptions="60-ceph.sh 80-tempest.sh"
Ian Wienand5cdee8d2015-10-19 14:17:18 +11001833 local extra
1834 extra=$(basename $extra_plugin_file_name)
Sean Dague1de9e332015-10-07 08:46:13 -04001835 if [[ ! ( $exceptions =~ "$extra" ) ]]; then
Sean Dague41d01102015-12-03 08:12:23 -05001836 warn "use of extras.d is no longer supported"
1837 warn "processing of project $extra is skipped"
1838 else
1839 [[ -r $extra_plugin_file_name ]] && source $extra_plugin_file_name $mode $phase
Sean Dague1de9e332015-10-07 08:46:13 -04001840 fi
Sean Dague2c65e712014-12-18 09:44:56 -05001841 done
1842 fi
1843 # the source phase corresponds to settings loading in plugins
1844 if [[ "$mode" == "source" ]]; then
1845 load_plugin_settings
Chris Dentc6d47012015-10-09 14:57:05 +00001846 verify_disabled_services
Sean Dague6e275e12015-03-26 05:54:28 -04001847 elif [[ "$mode" == "override_defaults" ]]; then
1848 plugin_override_defaults
Sean Dague2c65e712014-12-18 09:44:56 -05001849 else
1850 run_plugins $mode $phase
1851 fi
1852}
1853
Dean Troyerdff49a22014-01-30 15:37:40 -06001854
1855# Service Functions
1856# =================
1857
1858# remove extra commas from the input string (i.e. ``ENABLED_SERVICES``)
1859# _cleanup_service_list service-list
Ian Wienandaee18c72014-02-21 15:35:08 +11001860function _cleanup_service_list {
Ian Wienand8043bfa2015-10-14 14:53:18 +11001861 local xtrace
1862 xtrace=$(set +o | grep xtrace)
1863 set +o xtrace
1864
Dean Troyerdff49a22014-01-30 15:37:40 -06001865 echo "$1" | sed -e '
1866 s/,,/,/g;
1867 s/^,//;
1868 s/,$//
1869 '
Ian Wienand8043bfa2015-10-14 14:53:18 +11001870
1871 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001872}
1873
1874# disable_all_services() removes all current services
1875# from ``ENABLED_SERVICES`` to reset the configuration
1876# before a minimal installation
1877# Uses global ``ENABLED_SERVICES``
1878# disable_all_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001879function disable_all_services {
Dean Troyerdff49a22014-01-30 15:37:40 -06001880 ENABLED_SERVICES=""
1881}
1882
1883# Remove all services starting with '-'. For example, to install all default
1884# services except rabbit (rabbit) set in ``localrc``:
1885# ENABLED_SERVICES+=",-rabbit"
1886# Uses global ``ENABLED_SERVICES``
1887# disable_negated_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001888function disable_negated_services {
Ian Wienand8043bfa2015-10-14 14:53:18 +11001889 local xtrace
1890 xtrace=$(set +o | grep xtrace)
1891 set +o xtrace
1892
Ian Wienand2796a822015-04-15 08:59:04 +10001893 local to_remove=""
1894 local remaining=""
Dean Troyerdff49a22014-01-30 15:37:40 -06001895 local service
Ian Wienand2796a822015-04-15 08:59:04 +10001896
1897 # build up list of services that should be removed; i.e. they
1898 # begin with "-"
1899 for service in ${ENABLED_SERVICES//,/ }; do
Dean Troyerdff49a22014-01-30 15:37:40 -06001900 if [[ ${service} == -* ]]; then
Ian Wienand2796a822015-04-15 08:59:04 +10001901 to_remove+=",${service#-}"
1902 else
1903 remaining+=",${service}"
Dean Troyerdff49a22014-01-30 15:37:40 -06001904 fi
1905 done
Ian Wienand2796a822015-04-15 08:59:04 +10001906
1907 # go through the service list. if this service appears in the "to
1908 # be removed" list, drop it
fumihiko kakuma8606c982015-04-13 09:55:06 +09001909 ENABLED_SERVICES=$(remove_disabled_services "$remaining" "$to_remove")
Ian Wienand8043bfa2015-10-14 14:53:18 +11001910
1911 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001912}
1913
Chris Dentc6d47012015-10-09 14:57:05 +00001914# disable_service() prepares the services passed as argument to be
1915# removed from the ``ENABLED_SERVICES`` list, if they are present.
Dean Troyerdff49a22014-01-30 15:37:40 -06001916#
1917# For example:
1918# disable_service rabbit
1919#
Chris Dentc6d47012015-10-09 14:57:05 +00001920# Uses global ``DISABLED_SERVICES``
Dean Troyerdff49a22014-01-30 15:37:40 -06001921# disable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001922function disable_service {
Ian Wienand8043bfa2015-10-14 14:53:18 +11001923 local xtrace
1924 xtrace=$(set +o | grep xtrace)
1925 set +o xtrace
1926
Chris Dentc6d47012015-10-09 14:57:05 +00001927 local disabled_svcs="${DISABLED_SERVICES}"
1928 local enabled_svcs=",${ENABLED_SERVICES},"
Dean Troyerdff49a22014-01-30 15:37:40 -06001929 local service
1930 for service in $@; do
Chris Dentc6d47012015-10-09 14:57:05 +00001931 disabled_svcs+=",$service"
Dean Troyerdff49a22014-01-30 15:37:40 -06001932 if is_service_enabled $service; then
Chris Dentc6d47012015-10-09 14:57:05 +00001933 enabled_svcs=${enabled_svcs//,$service,/,}
Dean Troyerdff49a22014-01-30 15:37:40 -06001934 fi
1935 done
Chris Dentc6d47012015-10-09 14:57:05 +00001936 DISABLED_SERVICES=$(_cleanup_service_list "$disabled_svcs")
1937 ENABLED_SERVICES=$(_cleanup_service_list "$enabled_svcs")
Ian Wienand8043bfa2015-10-14 14:53:18 +11001938
1939 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001940}
1941
1942# enable_service() adds the services passed as argument to the
1943# ``ENABLED_SERVICES`` list, if they are not already present.
1944#
1945# For example:
Sean Dague37eca482015-06-16 07:19:22 -04001946# enable_service q-svc
Dean Troyerdff49a22014-01-30 15:37:40 -06001947#
1948# This function does not know about the special cases
1949# for nova, glance, and neutron built into is_service_enabled().
1950# Uses global ``ENABLED_SERVICES``
1951# enable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001952function enable_service {
Ian Wienand8043bfa2015-10-14 14:53:18 +11001953 local xtrace
1954 xtrace=$(set +o | grep xtrace)
1955 set +o xtrace
1956
Dean Troyerdff49a22014-01-30 15:37:40 -06001957 local tmpsvcs="${ENABLED_SERVICES}"
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001958 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06001959 for service in $@; do
Chris Dentc6d47012015-10-09 14:57:05 +00001960 if [[ ,${DISABLED_SERVICES}, =~ ,${service}, ]]; then
1961 warn $LINENO "Attempt to enable_service ${service} when it has been disabled"
1962 continue
1963 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001964 if ! is_service_enabled $service; then
1965 tmpsvcs+=",$service"
1966 fi
1967 done
1968 ENABLED_SERVICES=$(_cleanup_service_list "$tmpsvcs")
1969 disable_negated_services
Ian Wienand8043bfa2015-10-14 14:53:18 +11001970
1971 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001972}
1973
1974# is_service_enabled() checks if the service(s) specified as arguments are
1975# enabled by the user in ``ENABLED_SERVICES``.
1976#
1977# Multiple services specified as arguments are ``OR``'ed together; the test
1978# is a short-circuit boolean, i.e it returns on the first match.
1979#
1980# There are special cases for some 'catch-all' services::
1981# **nova** returns true if any service enabled start with **n-**
1982# **cinder** returns true if any service enabled start with **c-**
Dean Troyerdff49a22014-01-30 15:37:40 -06001983# **glance** returns true if any service enabled start with **g-**
1984# **neutron** returns true if any service enabled start with **q-**
1985# **swift** returns true if any service enabled start with **s-**
1986# **trove** returns true if any service enabled start with **tr-**
1987# For backward compatibility if we have **swift** in ENABLED_SERVICES all the
1988# **s-** services will be enabled. This will be deprecated in the future.
1989#
1990# Cells within nova is enabled if **n-cell** is in ``ENABLED_SERVICES``.
1991# We also need to make sure to treat **n-cell-region** and **n-cell-child**
1992# as enabled in this case.
1993#
1994# Uses global ``ENABLED_SERVICES``
1995# is_service_enabled service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001996function is_service_enabled {
Ian Wienand433a9b12015-10-07 13:29:31 +11001997 local xtrace
1998 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -05001999 set +o xtrace
Ian Wienand8043bfa2015-10-14 14:53:18 +11002000
Sean Dague45917cc2014-02-24 16:09:14 -05002001 local enabled=1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05002002 local services=$@
2003 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06002004 for service in ${services}; do
Sean Dague45917cc2014-02-24 16:09:14 -05002005 [[ ,${ENABLED_SERVICES}, =~ ,${service}, ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06002006
2007 # Look for top-level 'enabled' function for this service
2008 if type is_${service}_enabled >/dev/null 2>&1; then
2009 # A function exists for this service, use it
Christian Schwede3db0aad2015-09-10 11:15:39 +00002010 is_${service}_enabled && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06002011 fi
2012
2013 # TODO(dtroyer): Remove these legacy special-cases after the is_XXX_enabled()
2014 # are implemented
2015
Sean Dague45917cc2014-02-24 16:09:14 -05002016 [[ ${service} == n-cell-* && ${ENABLED_SERVICES} =~ "n-cell" ]] && enabled=0
Chris Dent2f27a0e2014-09-09 13:46:02 +01002017 [[ ${service} == n-cpu-* && ${ENABLED_SERVICES} =~ "n-cpu" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05002018 [[ ${service} == "nova" && ${ENABLED_SERVICES} =~ "n-" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05002019 [[ ${service} == "glance" && ${ENABLED_SERVICES} =~ "g-" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05002020 [[ ${service} == "neutron" && ${ENABLED_SERVICES} =~ "q-" ]] && enabled=0
2021 [[ ${service} == "trove" && ${ENABLED_SERVICES} =~ "tr-" ]] && enabled=0
2022 [[ ${service} == "swift" && ${ENABLED_SERVICES} =~ "s-" ]] && enabled=0
2023 [[ ${service} == s-* && ${ENABLED_SERVICES} =~ "swift" ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06002024 done
Ian Wienand8043bfa2015-10-14 14:53:18 +11002025
Sean Dague45917cc2014-02-24 16:09:14 -05002026 $xtrace
2027 return $enabled
Dean Troyerdff49a22014-01-30 15:37:40 -06002028}
2029
fumihiko kakuma8606c982015-04-13 09:55:06 +09002030# remove specified list from the input string
2031# remove_disabled_services service-list remove-list
2032function remove_disabled_services {
Ian Wienand8043bfa2015-10-14 14:53:18 +11002033 local xtrace
2034 xtrace=$(set +o | grep xtrace)
2035 set +o xtrace
2036
fumihiko kakuma8606c982015-04-13 09:55:06 +09002037 local service_list=$1
2038 local remove_list=$2
2039 local service
2040 local enabled=""
2041
2042 for service in ${service_list//,/ }; do
2043 local remove
2044 local add=1
2045 for remove in ${remove_list//,/ }; do
2046 if [[ ${remove} == ${service} ]]; then
2047 add=0
2048 break
2049 fi
2050 done
2051 if [[ $add == 1 ]]; then
2052 enabled="${enabled},$service"
2053 fi
2054 done
Ian Wienand8043bfa2015-10-14 14:53:18 +11002055
2056 $xtrace
2057
fumihiko kakuma8606c982015-04-13 09:55:06 +09002058 _cleanup_service_list "$enabled"
2059}
2060
Dean Troyerdff49a22014-01-30 15:37:40 -06002061# Toggle enable/disable_service for services that must run exclusive of each other
2062# $1 The name of a variable containing a space-separated list of services
2063# $2 The name of a variable in which to store the enabled service's name
2064# $3 The name of the service to enable
2065function use_exclusive_service {
2066 local options=${!1}
2067 local selection=$3
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05002068 local out=$2
Dean Troyerdff49a22014-01-30 15:37:40 -06002069 [ -z $selection ] || [[ ! "$options" =~ "$selection" ]] && return 1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05002070 local opt
Dean Troyerdff49a22014-01-30 15:37:40 -06002071 for opt in $options;do
2072 [[ "$opt" = "$selection" ]] && enable_service $opt || disable_service $opt
2073 done
2074 eval "$out=$selection"
2075 return 0
2076}
2077
Chris Dentc6d47012015-10-09 14:57:05 +00002078# Make sure that nothing has manipulated ENABLED_SERVICES in a way
2079# that conflicts with prior calls to disable_service.
2080# Uses global ``ENABLED_SERVICES``
2081function verify_disabled_services {
2082 local service
2083 for service in ${ENABLED_SERVICES//,/ }; do
2084 if [[ ,${DISABLED_SERVICES}, =~ ,${service}, ]]; then
2085 die $LINENO "ENABLED_SERVICES directly modified to overcome 'disable_service ${service}'"
2086 fi
2087 done
2088}
2089
Dean Troyerdff49a22014-01-30 15:37:40 -06002090
Masayuki Igawaf6368d32014-02-20 13:31:26 +09002091# System Functions
2092# ================
Dean Troyerdff49a22014-01-30 15:37:40 -06002093
2094# Only run the command if the target file (the last arg) is not on an
2095# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002096function _safe_permission_operation {
Ian Wienand433a9b12015-10-07 13:29:31 +11002097 local xtrace
2098 xtrace=$(set +o | grep xtrace)
Sean Dague45917cc2014-02-24 16:09:14 -05002099 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06002100 local args=( $@ )
2101 local last
2102 local sudo_cmd
2103 local dir_to_check
2104
2105 let last="${#args[*]} - 1"
2106
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05002107 local dir_to_check=${args[$last]}
Dean Troyerdff49a22014-01-30 15:37:40 -06002108 if [ ! -d "$dir_to_check" ]; then
2109 dir_to_check=`dirname "$dir_to_check"`
2110 fi
2111
2112 if is_nfs_directory "$dir_to_check" ; then
Sean Dague45917cc2014-02-24 16:09:14 -05002113 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06002114 return 0
2115 fi
2116
2117 if [[ $TRACK_DEPENDS = True ]]; then
2118 sudo_cmd="env"
2119 else
2120 sudo_cmd="sudo"
2121 fi
2122
Sean Dague45917cc2014-02-24 16:09:14 -05002123 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06002124 $sudo_cmd $@
2125}
2126
2127# Exit 0 if address is in network or 1 if address is not in network
2128# ip-range is in CIDR notation: 1.2.3.4/20
2129# address_in_net ip-address ip-range
Ian Wienandaee18c72014-02-21 15:35:08 +11002130function address_in_net {
Dean Troyerdff49a22014-01-30 15:37:40 -06002131 local ip=$1
2132 local range=$2
2133 local masklen=${range#*/}
Ian Wienandada886d2015-10-07 14:06:26 +11002134 local network
2135 network=$(maskip ${range%/*} $(cidr2netmask $masklen))
2136 local subnet
2137 subnet=$(maskip $ip $(cidr2netmask $masklen))
Dean Troyerdff49a22014-01-30 15:37:40 -06002138 [[ $network == $subnet ]]
2139}
2140
2141# Add a user to a group.
2142# add_user_to_group user group
Ian Wienandaee18c72014-02-21 15:35:08 +11002143function add_user_to_group {
Dean Troyerdff49a22014-01-30 15:37:40 -06002144 local user=$1
2145 local group=$2
2146
Thomas Bechtolda8580852015-05-31 00:04:33 +02002147 sudo usermod -a -G "$group" "$user"
Dean Troyerdff49a22014-01-30 15:37:40 -06002148}
2149
2150# Convert CIDR notation to a IPv4 netmask
2151# cidr2netmask cidr-bits
Ian Wienandaee18c72014-02-21 15:35:08 +11002152function cidr2netmask {
Dean Troyerdff49a22014-01-30 15:37:40 -06002153 local maskpat="255 255 255 255"
2154 local maskdgt="254 252 248 240 224 192 128"
2155 set -- ${maskpat:0:$(( ($1 / 8) * 4 ))}${maskdgt:$(( (7 - ($1 % 8)) * 4 )):3}
2156 echo ${1-0}.${2-0}.${3-0}.${4-0}
2157}
2158
2159# Gracefully cp only if source file/dir exists
2160# cp_it source destination
2161function cp_it {
2162 if [ -e $1 ] || [ -d $1 ]; then
2163 cp -pRL $1 $2
2164 fi
2165}
2166
2167# HTTP and HTTPS proxy servers are supported via the usual environment variables [1]
2168# ``http_proxy``, ``https_proxy`` and ``no_proxy``. They can be set in
2169# ``localrc`` or on the command line if necessary::
2170#
2171# [1] http://www.w3.org/Daemon/User/Proxies/ProxyClients.html
2172#
2173# http_proxy=http://proxy.example.com:3128/ no_proxy=repo.example.net ./stack.sh
2174
Ian Wienandaee18c72014-02-21 15:35:08 +11002175function export_proxy_variables {
Sean Dague53753292014-12-04 19:38:15 -05002176 if isset http_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002177 export http_proxy=$http_proxy
2178 fi
Sean Dague53753292014-12-04 19:38:15 -05002179 if isset https_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002180 export https_proxy=$https_proxy
2181 fi
Sean Dague53753292014-12-04 19:38:15 -05002182 if isset no_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002183 export no_proxy=$no_proxy
2184 fi
2185}
2186
2187# Returns true if the directory is on a filesystem mounted via NFS.
Ian Wienandaee18c72014-02-21 15:35:08 +11002188function is_nfs_directory {
Ian Wienandada886d2015-10-07 14:06:26 +11002189 local mount_type
2190 mount_type=`stat -f -L -c %T $1`
Dean Troyerdff49a22014-01-30 15:37:40 -06002191 test "$mount_type" == "nfs"
2192}
2193
2194# Return the network portion of the given IP address using netmask
2195# netmask is in the traditional dotted-quad format
2196# maskip ip-address netmask
Ian Wienandaee18c72014-02-21 15:35:08 +11002197function maskip {
Dean Troyerdff49a22014-01-30 15:37:40 -06002198 local ip=$1
2199 local mask=$2
2200 local l="${ip%.*}"; local r="${ip#*.}"; local n="${mask%.*}"; local m="${mask#*.}"
Ian Wienandada886d2015-10-07 14:06:26 +11002201 local subnet
2202 subnet=$((${ip%%.*}&${mask%%.*})).$((${r%%.*}&${m%%.*})).$((${l##*.}&${n##*.})).$((${ip##*.}&${mask##*.}))
Dean Troyerdff49a22014-01-30 15:37:40 -06002203 echo $subnet
2204}
2205
Chris Dent3a2c86a2015-05-12 13:41:25 +00002206# Return the current python as "python<major>.<minor>"
2207function python_version {
Ian Wienandada886d2015-10-07 14:06:26 +11002208 local python_version
2209 python_version=$(python -c 'import sys; print("%s.%s" % sys.version_info[0:2])')
Chris Dent3a2c86a2015-05-12 13:41:25 +00002210 echo "python${python_version}"
2211}
2212
Dean Troyerdff49a22014-01-30 15:37:40 -06002213# Service wrapper to restart services
2214# restart_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002215function restart_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002216 if is_ubuntu; then
2217 sudo /usr/sbin/service $1 restart
2218 else
2219 sudo /sbin/service $1 restart
2220 fi
2221}
2222
2223# Only change permissions of a file or directory if it is not on an
2224# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002225function safe_chmod {
Dean Troyerdff49a22014-01-30 15:37:40 -06002226 _safe_permission_operation chmod $@
2227}
2228
2229# Only change ownership of a file or directory if it is not on an NFS
2230# filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002231function safe_chown {
Dean Troyerdff49a22014-01-30 15:37:40 -06002232 _safe_permission_operation chown $@
2233}
2234
2235# Service wrapper to start services
2236# start_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002237function start_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002238 if is_ubuntu; then
2239 sudo /usr/sbin/service $1 start
2240 else
2241 sudo /sbin/service $1 start
2242 fi
2243}
2244
2245# Service wrapper to stop services
2246# stop_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002247function stop_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002248 if is_ubuntu; then
2249 sudo /usr/sbin/service $1 stop
2250 else
2251 sudo /sbin/service $1 stop
2252 fi
2253}
2254
Sean Dague442e4e92015-06-24 13:24:02 -04002255# Test with a finite retry loop.
2256#
2257function test_with_retry {
2258 local testcmd=$1
2259 local failmsg=$2
2260 local until=${3:-10}
2261 local sleep=${4:-0.5}
2262
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +09002263 time_start "test_with_retry"
Sean Dague442e4e92015-06-24 13:24:02 -04002264 if ! timeout $until sh -c "while ! $testcmd; do sleep $sleep; done"; then
2265 die $LINENO "$failmsg"
2266 fi
Atsushi SAKAI2ca8af42015-12-08 15:36:13 +09002267 time_stop "test_with_retry"
Sean Dague442e4e92015-06-24 13:24:02 -04002268}
2269
Federico Ressi5dcbf7a2016-01-13 12:17:32 +00002270# Like sudo but forwarding http_proxy https_proxy no_proxy environment vars.
2271# If it is run as superuser then sudo is replaced by env.
2272#
2273function sudo_with_proxies {
2274 local sudo
2275
2276 [[ "$(id -u)" = "0" ]] && sudo="env" || sudo="sudo"
2277
2278 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}"\
2279 no_proxy="${no_proxy:-}" "$@"
2280}
2281
Sean Dague95c33d52015-10-07 11:05:59 -04002282# Timing infrastructure - figure out where large blocks of time are
2283# used in DevStack
2284#
2285# The timing infrastructure for DevStack is about collecting buckets
2286# of time that are spend in some subtask. For instance, that might be
2287# 'apt', 'pip', 'osc', even database migrations. We do this by a pair
2288# of functions: time_start / time_stop.
2289#
2290# These take a single parameter: $name - which specifies the name of
2291# the bucket to be accounted against. time_totals function spits out
2292# the results.
2293#
2294# Resolution is only in whole seconds, so should be used for long
2295# running activities.
2296
2297declare -A TOTAL_TIME
2298declare -A START_TIME
2299
2300# time_start $name
2301#
2302# starts the clock for a timer by name. Errors if that clock is
2303# already started.
2304function time_start {
2305 local name=$1
2306 local start_time=${START_TIME[$name]}
2307 if [[ -n "$start_time" ]]; then
2308 die $LINENO "Trying to start the clock on $name, but it's already been started"
2309 fi
2310 START_TIME[$name]=$(date +%s)
2311}
2312
2313# time_stop $name
2314#
2315# stops the clock for a timer by name, and accumulate that time in the
2316# global counter for that name. Errors if that clock had not
2317# previously been started.
2318function time_stop {
Ian Wienand5cdee8d2015-10-19 14:17:18 +11002319 local name
2320 local end_time
2321 local elpased_time
2322 local total
2323 local start_time
2324
2325 name=$1
2326 start_time=${START_TIME[$name]}
2327
Sean Dague95c33d52015-10-07 11:05:59 -04002328 if [[ -z "$start_time" ]]; then
2329 die $LINENO "Trying to stop the clock on $name, but it was never started"
2330 fi
Ian Wienand5cdee8d2015-10-19 14:17:18 +11002331 end_time=$(date +%s)
2332 elapsed_time=$(($end_time - $start_time))
2333 total=${TOTAL_TIME[$name]:-0}
Sean Dague95c33d52015-10-07 11:05:59 -04002334 # reset the clock so we can start it in the future
2335 START_TIME[$name]=""
2336 TOTAL_TIME[$name]=$(($total + $elapsed_time))
2337}
2338
2339# time_totals
2340#
2341# prints out total time
2342function time_totals {
2343 echo
2344 echo "========================"
2345 echo "DevStack Components Timed"
2346 echo "========================"
2347 echo
2348 for t in ${!TOTAL_TIME[*]}; do
2349 local v=${TOTAL_TIME[$t]}
2350 echo "$t - $v secs"
2351 done
2352}
Dean Troyerdff49a22014-01-30 15:37:40 -06002353
2354# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +11002355$_XTRACE_FUNCTIONS_COMMON
Dean Troyerdff49a22014-01-30 15:37:40 -06002356
2357# Local variables:
2358# mode: shell-script
2359# End: