blob: 0e157290bcb60bc329983dbd5c25a3bb117dc8a5 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyerdff49a22014-01-30 15:37:40 -06003# functions-common - Common functions used by DevStack components
4#
5# The canonical copy of this file is maintained in the DevStack repo.
6# All modifications should be made there and then sync'ed to other repos
7# as required.
8#
9# This file is sorted alphabetically within the function groups.
10#
11# - Config Functions
12# - Control Functions
13# - Distro Functions
14# - Git Functions
15# - OpenStack Functions
16# - Package Functions
17# - Process Functions
Dean Troyerdff49a22014-01-30 15:37:40 -060018# - Service Functions
Masayuki Igawaf6368d32014-02-20 13:31:26 +090019# - System Functions
Dean Troyerdff49a22014-01-30 15:37:40 -060020#
21# The following variables are assumed to be defined by certain functions:
22#
23# - ``ENABLED_SERVICES``
24# - ``ERROR_ON_CLONE``
25# - ``FILES``
26# - ``OFFLINE``
Dean Troyerdff49a22014-01-30 15:37:40 -060027# - ``RECLONE``
Masayuki Igawad20f6322014-02-28 09:22:37 +090028# - ``REQUIREMENTS_DIR``
29# - ``STACK_USER``
Dean Troyerdff49a22014-01-30 15:37:40 -060030# - ``TRACK_DEPENDS``
31# - ``http_proxy``, ``https_proxy``, ``no_proxy``
Dean Troyer3324f192014-09-18 09:26:39 -050032#
Dean Troyerdff49a22014-01-30 15:37:40 -060033
34# Save trace setting
35XTRACE=$(set +o | grep xtrace)
36set +o xtrace
37
Ian Wienand4ffb4542015-06-30 11:00:32 +100038# ensure we don't re-source this in the same environment
39[[ -z "$_DEVSTACK_FUNCTIONS_COMMON" ]] || return 0
40declare -r _DEVSTACK_FUNCTIONS_COMMON=1
41
Sean Daguecc524062014-10-01 09:06:43 -040042# Global Config Variables
43declare -A GITREPO
44declare -A GITBRANCH
45declare -A GITDIR
46
Sean Dague53753292014-12-04 19:38:15 -050047TRACK_DEPENDS=${TRACK_DEPENDS:-False}
48
Dean Troyer68162342015-05-13 15:41:03 -050049# Save these variables to .stackenv
50STACK_ENV_VARS="BASE_SQL_CONN DATA_DIR DEST ENABLED_SERVICES HOST_IP \
51 KEYSTONE_AUTH_PROTOCOL KEYSTONE_AUTH_URI KEYSTONE_SERVICE_URI \
Brian Haley180f5eb2015-06-16 13:14:31 -040052 LOGFILE OS_CACERT SERVICE_HOST SERVICE_PROTOCOL STACK_USER TLS_IP \
Brian Haley5d04db22015-06-16 13:14:31 -040053 HOST_IPV6 SERVICE_IP_VERSION"
Dean Troyer68162342015-05-13 15:41:03 -050054
55
56# Saves significant environment variables to .stackenv for later use
57# Refers to a lot of globals, only TOP_DIR and STACK_ENV_VARS are required to
58# function, the rest are simply saved and do not cause problems if they are undefined.
59# save_stackenv [tag]
60function save_stackenv {
61 local tag=${1:-""}
62 # Save some values we generated for later use
63 time_stamp=$(date "+$TIMESTAMP_FORMAT")
64 echo "# $time_stamp $tag" >$TOP_DIR/.stackenv
65 for i in $STACK_ENV_VARS; do
66 echo $i=${!i} >>$TOP_DIR/.stackenv
67 done
68}
Dean Troyerdff49a22014-01-30 15:37:40 -060069
Monty Taylor7224eec2015-09-19 11:26:18 -040070# Update/create user clouds.yaml file.
71# clouds.yaml will have
72# - A `devstack` entry for the `demo` user for the `demo` project.
73# - A `devstack-admin` entry for the `admin` user for the `admin` project.
74# write_clouds_yaml
75function write_clouds_yaml {
76 # 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.
79 CLOUDS_YAML=~/.config/openstack/clouds.yaml
80
81 mkdir -p $(dirname $CLOUDS_YAML)
82
83 CA_CERT_ARG=''
84 if [ -f "$SSL_BUNDLE_FILE" ]; then
85 CA_CERT_ARG="--os-cacert $SSL_BUNDLE_FILE"
86 fi
87 $TOP_DIR/tools/update_clouds_yaml.py \
88 --file $CLOUDS_YAML \
89 --os-cloud devstack \
90 --os-region-name $REGION_NAME \
Steve Martinelli050a0d52015-09-06 22:03:54 +000091 --os-identity-api-version 3 \
Monty Taylor7224eec2015-09-19 11:26:18 -040092 $CA_CERT_ARG \
Steve Martinelli050a0d52015-09-06 22:03:54 +000093 --os-auth-url $KEYSTONE_AUTH_URI \
Monty Taylor7224eec2015-09-19 11:26:18 -040094 --os-username demo \
95 --os-password $ADMIN_PASSWORD \
96 --os-project-name demo
97 $TOP_DIR/tools/update_clouds_yaml.py \
98 --file $CLOUDS_YAML \
99 --os-cloud devstack-admin \
100 --os-region-name $REGION_NAME \
Steve Martinelli050a0d52015-09-06 22:03:54 +0000101 --os-identity-api-version 3 \
Monty Taylor7224eec2015-09-19 11:26:18 -0400102 $CA_CERT_ARG \
Steve Martinelli050a0d52015-09-06 22:03:54 +0000103 --os-auth-url $KEYSTONE_AUTH_URI \
Monty Taylor7224eec2015-09-19 11:26:18 -0400104 --os-username admin \
105 --os-password $ADMIN_PASSWORD \
106 --os-project-name admin
107}
108
Dean Troyerdff49a22014-01-30 15:37:40 -0600109# Normalize config values to True or False
110# Accepts as False: 0 no No NO false False FALSE
111# Accepts as True: 1 yes Yes YES true True TRUE
112# VAR=$(trueorfalse default-value test-value)
Ian Wienandaee18c72014-02-21 15:35:08 +1100113function trueorfalse {
Sean Dague45917cc2014-02-24 16:09:14 -0500114 local xtrace=$(set +o | grep xtrace)
115 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600116
Mahito OGURA98f59aa2015-05-11 18:02:34 +0900117 local default=$1
118 local testval=${!2:-}
119
120 case "$testval" in
121 "1" | [yY]es | "YES" | [tT]rue | "TRUE" ) echo "True" ;;
122 "0" | [nN]o | "NO" | [fF]alse | "FALSE" ) echo "False" ;;
123 * ) echo "$default" ;;
124 esac
125
Sean Dague45917cc2014-02-24 16:09:14 -0500126 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600127}
128
Attila Fazekas1bd79592015-02-24 14:06:56 +0100129function isset {
130 [[ -v "$1" ]]
131}
Dean Troyerdff49a22014-01-30 15:37:40 -0600132
Dean Troyer68162342015-05-13 15:41:03 -0500133
Dean Troyerdff49a22014-01-30 15:37:40 -0600134# Control Functions
135# =================
136
137# Prints backtrace info
138# filename:lineno:function
139# backtrace level
140function backtrace {
141 local level=$1
142 local deep=$((${#BASH_SOURCE[@]} - 1))
143 echo "[Call Trace]"
144 while [ $level -le $deep ]; do
145 echo "${BASH_SOURCE[$deep]}:${BASH_LINENO[$deep-1]}:${FUNCNAME[$deep-1]}"
146 deep=$((deep - 1))
147 done
148}
149
150# Prints line number and "message" then exits
151# die $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100152function die {
Dean Troyerdff49a22014-01-30 15:37:40 -0600153 local exitcode=$?
154 set +o xtrace
155 local line=$1; shift
156 if [ $exitcode == 0 ]; then
157 exitcode=1
158 fi
159 backtrace 2
160 err $line "$*"
Dean Troyera25a6f62014-02-24 16:03:41 -0600161 # Give buffers a second to flush
162 sleep 1
Dean Troyerdff49a22014-01-30 15:37:40 -0600163 exit $exitcode
164}
165
166# Checks an environment variable is not set or has length 0 OR if the
167# exit code is non-zero and prints "message" and exits
168# NOTE: env-var is the variable name without a '$'
169# die_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100170function die_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600171 local exitcode=$?
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500172 local xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600173 set +o xtrace
174 local line=$1; shift
175 local evar=$1; shift
176 if ! is_set $evar || [ $exitcode != 0 ]; then
177 die $line "$*"
178 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500179 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600180}
181
Sean Dague1de9e332015-10-07 08:46:13 -0400182function deprecated {
183 local text=$1
184 DEPRECATED_TEXT+="\n$text"
185 echo "WARNING: $text"
186}
187
Dean Troyerdff49a22014-01-30 15:37:40 -0600188# Prints line number and "message" in error format
189# err $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100190function err {
Dean Troyerdff49a22014-01-30 15:37:40 -0600191 local exitcode=$?
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500192 local xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600193 set +o xtrace
194 local msg="[ERROR] ${BASH_SOURCE[2]}:$1 $2"
195 echo $msg 1>&2;
Dean Troyerdde41d02014-12-09 17:47:57 -0600196 if [[ -n ${LOGDIR} ]]; then
197 echo $msg >> "${LOGDIR}/error.log"
Dean Troyerdff49a22014-01-30 15:37:40 -0600198 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500199 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600200 return $exitcode
201}
202
203# Checks an environment variable is not set or has length 0 OR if the
204# exit code is non-zero and prints "message"
205# NOTE: env-var is the variable name without a '$'
206# err_if_not_set $LINENO env-var "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100207function err_if_not_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600208 local exitcode=$?
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500209 local xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600210 set +o xtrace
211 local line=$1; shift
212 local evar=$1; shift
213 if ! is_set $evar || [ $exitcode != 0 ]; then
214 err $line "$*"
215 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500216 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600217 return $exitcode
218}
219
220# Exit after outputting a message about the distribution not being supported.
221# exit_distro_not_supported [optional-string-telling-what-is-missing]
222function exit_distro_not_supported {
223 if [[ -z "$DISTRO" ]]; then
224 GetDistro
225 fi
226
227 if [ $# -gt 0 ]; then
228 die $LINENO "Support for $DISTRO is incomplete: no support for $@"
229 else
230 die $LINENO "Support for $DISTRO is incomplete."
231 fi
232}
233
234# Test if the named environment variable is set and not zero length
235# is_set env-var
Ian Wienandaee18c72014-02-21 15:35:08 +1100236function is_set {
Dean Troyerdff49a22014-01-30 15:37:40 -0600237 local var=\$"$1"
238 eval "[ -n \"$var\" ]" # For ex.: sh -c "[ -n \"$var\" ]" would be better, but several exercises depends on this
239}
240
241# Prints line number and "message" in warning format
242# warn $LINENO "message"
Ian Wienandaee18c72014-02-21 15:35:08 +1100243function warn {
Dean Troyerdff49a22014-01-30 15:37:40 -0600244 local exitcode=$?
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500245 local xtrace=$(set +o | grep xtrace)
Dean Troyerdff49a22014-01-30 15:37:40 -0600246 set +o xtrace
247 local msg="[WARNING] ${BASH_SOURCE[2]}:$1 $2"
Sean Daguee4af9292015-04-28 08:57:57 -0400248 echo $msg
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500249 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -0600250 return $exitcode
251}
252
253
254# Distro Functions
255# ================
256
257# Determine OS Vendor, Release and Update
258# Tested with OS/X, Ubuntu, RedHat, CentOS, Fedora
259# Returns results in global variables:
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500260# ``os_VENDOR`` - vendor name: ``Ubuntu``, ``Fedora``, etc
261# ``os_RELEASE`` - major release: ``14.04`` (Ubuntu), ``20`` (Fedora)
262# ``os_UPDATE`` - update: ex. the ``5`` in ``RHEL6.5``
263# ``os_PACKAGE`` - package type: ``deb`` or ``rpm``
264# ``os_CODENAME`` - vendor's codename for release: ``snow leopard``, ``trusty``
Sean Dague53753292014-12-04 19:38:15 -0500265os_VENDOR=""
266os_RELEASE=""
267os_UPDATE=""
268os_PACKAGE=""
269os_CODENAME=""
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500270
Dean Troyerdff49a22014-01-30 15:37:40 -0600271# GetOSVersion
Ian Wienandaee18c72014-02-21 15:35:08 +1100272function GetOSVersion {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500273
Dean Troyerdff49a22014-01-30 15:37:40 -0600274 # Figure out which vendor we are
275 if [[ -x "`which sw_vers 2>/dev/null`" ]]; then
276 # OS/X
277 os_VENDOR=`sw_vers -productName`
278 os_RELEASE=`sw_vers -productVersion`
279 os_UPDATE=${os_RELEASE##*.}
280 os_RELEASE=${os_RELEASE%.*}
281 os_PACKAGE=""
282 if [[ "$os_RELEASE" =~ "10.7" ]]; then
283 os_CODENAME="lion"
284 elif [[ "$os_RELEASE" =~ "10.6" ]]; then
285 os_CODENAME="snow leopard"
286 elif [[ "$os_RELEASE" =~ "10.5" ]]; then
287 os_CODENAME="leopard"
288 elif [[ "$os_RELEASE" =~ "10.4" ]]; then
289 os_CODENAME="tiger"
290 elif [[ "$os_RELEASE" =~ "10.3" ]]; then
291 os_CODENAME="panther"
292 else
293 os_CODENAME=""
294 fi
295 elif [[ -x $(which lsb_release 2>/dev/null) ]]; then
296 os_VENDOR=$(lsb_release -i -s)
297 os_RELEASE=$(lsb_release -r -s)
298 os_UPDATE=""
299 os_PACKAGE="rpm"
300 if [[ "Debian,Ubuntu,LinuxMint" =~ $os_VENDOR ]]; then
301 os_PACKAGE="deb"
302 elif [[ "SUSE LINUX" =~ $os_VENDOR ]]; then
303 lsb_release -d -s | grep -q openSUSE
304 if [[ $? -eq 0 ]]; then
305 os_VENDOR="openSUSE"
306 fi
307 elif [[ $os_VENDOR == "openSUSE project" ]]; then
308 os_VENDOR="openSUSE"
309 elif [[ $os_VENDOR =~ Red.*Hat ]]; then
310 os_VENDOR="Red Hat"
311 fi
312 os_CODENAME=$(lsb_release -c -s)
313 elif [[ -r /etc/redhat-release ]]; then
314 # Red Hat Enterprise Linux Server release 5.5 (Tikanga)
315 # Red Hat Enterprise Linux Server release 7.0 Beta (Maipo)
316 # CentOS release 5.5 (Final)
317 # CentOS Linux release 6.0 (Final)
318 # Fedora release 16 (Verne)
319 # XenServer release 6.2.0-70446c (xenenterprise)
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700320 # Oracle Linux release 7
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300321 # CloudLinux release 7.1
Dean Troyerdff49a22014-01-30 15:37:40 -0600322 os_CODENAME=""
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300323 for r in "Red Hat" CentOS Fedora XenServer CloudLinux; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600324 os_VENDOR=$r
325 if [[ -n "`grep \"$r\" /etc/redhat-release`" ]]; then
326 ver=`sed -e 's/^.* \([0-9].*\) (\(.*\)).*$/\1\|\2/' /etc/redhat-release`
327 os_CODENAME=${ver#*|}
328 os_RELEASE=${ver%|*}
329 os_UPDATE=${os_RELEASE##*.}
330 os_RELEASE=${os_RELEASE%.*}
331 break
332 fi
333 os_VENDOR=""
334 done
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700335 if [ "$os_VENDOR" = "Red Hat" ] && [[ -r /etc/oracle-release ]]; then
336 os_VENDOR=OracleLinux
337 fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600338 os_PACKAGE="rpm"
339 elif [[ -r /etc/SuSE-release ]]; then
340 for r in openSUSE "SUSE Linux"; do
341 if [[ "$r" = "SUSE Linux" ]]; then
342 os_VENDOR="SUSE LINUX"
343 else
344 os_VENDOR=$r
345 fi
346
347 if [[ -n "`grep \"$r\" /etc/SuSE-release`" ]]; then
348 os_CODENAME=`grep "CODENAME = " /etc/SuSE-release | sed 's:.* = ::g'`
349 os_RELEASE=`grep "VERSION = " /etc/SuSE-release | sed 's:.* = ::g'`
350 os_UPDATE=`grep "PATCHLEVEL = " /etc/SuSE-release | sed 's:.* = ::g'`
351 break
352 fi
353 os_VENDOR=""
354 done
355 os_PACKAGE="rpm"
356 # If lsb_release is not installed, we should be able to detect Debian OS
357 elif [[ -f /etc/debian_version ]] && [[ $(cat /proc/version) =~ "Debian" ]]; then
358 os_VENDOR="Debian"
359 os_PACKAGE="deb"
360 os_CODENAME=$(awk '/VERSION=/' /etc/os-release | sed 's/VERSION=//' | sed -r 's/\"|\(|\)//g' | awk '{print $2}')
361 os_RELEASE=$(awk '/VERSION_ID=/' /etc/os-release | sed 's/VERSION_ID=//' | sed 's/\"//g')
362 fi
363 export os_VENDOR os_RELEASE os_UPDATE os_PACKAGE os_CODENAME
364}
365
366# Translate the OS version values into common nomenclature
367# Sets global ``DISTRO`` from the ``os_*`` values
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500368declare DISTRO
369
Ian Wienandaee18c72014-02-21 15:35:08 +1100370function GetDistro {
Dean Troyerdff49a22014-01-30 15:37:40 -0600371 GetOSVersion
372 if [[ "$os_VENDOR" =~ (Ubuntu) || "$os_VENDOR" =~ (Debian) ]]; then
373 # 'Everyone' refers to Ubuntu / Debian releases by the code name adjective
374 DISTRO=$os_CODENAME
375 elif [[ "$os_VENDOR" =~ (Fedora) ]]; then
376 # For Fedora, just use 'f' and the release
377 DISTRO="f$os_RELEASE"
378 elif [[ "$os_VENDOR" =~ (openSUSE) ]]; then
379 DISTRO="opensuse-$os_RELEASE"
380 elif [[ "$os_VENDOR" =~ (SUSE LINUX) ]]; then
381 # For SLE, also use the service pack
382 if [[ -z "$os_UPDATE" ]]; then
383 DISTRO="sle${os_RELEASE}"
384 else
385 DISTRO="sle${os_RELEASE}sp${os_UPDATE}"
386 fi
anju Tiwari6c639c92014-07-15 18:11:54 +0530387 elif [[ "$os_VENDOR" =~ (Red Hat) || \
388 "$os_VENDOR" =~ (CentOS) || \
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700389 "$os_VENDOR" =~ (OracleLinux) ]]; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600390 # Drop the . release as we assume it's compatible
391 DISTRO="rhel${os_RELEASE::1}"
392 elif [[ "$os_VENDOR" =~ (XenServer) ]]; then
393 DISTRO="xs$os_RELEASE"
394 else
395 # Catch-all for now is Vendor + Release + Update
396 DISTRO="$os_VENDOR-$os_RELEASE.$os_UPDATE"
397 fi
398 export DISTRO
399}
400
401# Utility function for checking machine architecture
402# is_arch arch-type
403function is_arch {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500404 [[ "$(uname -m)" == "$1" ]]
Dean Troyerdff49a22014-01-30 15:37:40 -0600405}
406
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700407# Determine if current distribution is an Oracle distribution
408# is_oraclelinux
409function is_oraclelinux {
410 if [[ -z "$os_VENDOR" ]]; then
411 GetOSVersion
412 fi
413
414 [ "$os_VENDOR" = "OracleLinux" ]
415}
416
417
Dean Troyerdff49a22014-01-30 15:37:40 -0600418# Determine if current distribution is a Fedora-based distribution
419# (Fedora, RHEL, CentOS, etc).
420# is_fedora
421function is_fedora {
422 if [[ -z "$os_VENDOR" ]]; then
423 GetOSVersion
424 fi
425
anju Tiwari6c639c92014-07-15 18:11:54 +0530426 [ "$os_VENDOR" = "Fedora" ] || [ "$os_VENDOR" = "Red Hat" ] || \
Maxim Nestratove6f37b92015-06-30 14:54:12 +0300427 [ "$os_VENDOR" = "CentOS" ] || [ "$os_VENDOR" = "OracleLinux" ] || \
428 [ "$os_VENDOR" = "CloudLinux" ]
Dean Troyerdff49a22014-01-30 15:37:40 -0600429}
430
431
432# Determine if current distribution is a SUSE-based distribution
433# (openSUSE, SLE).
434# is_suse
435function is_suse {
436 if [[ -z "$os_VENDOR" ]]; then
437 GetOSVersion
438 fi
439
440 [ "$os_VENDOR" = "openSUSE" ] || [ "$os_VENDOR" = "SUSE LINUX" ]
441}
442
443
444# Determine if current distribution is an Ubuntu-based distribution
445# It will also detect non-Ubuntu but Debian-based distros
446# is_ubuntu
447function is_ubuntu {
448 if [[ -z "$os_PACKAGE" ]]; then
449 GetOSVersion
450 fi
451 [ "$os_PACKAGE" = "deb" ]
452}
453
454
455# Git Functions
456# =============
457
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600458# Returns openstack release name for a given branch name
459# ``get_release_name_from_branch branch-name``
Ian Wienandaee18c72014-02-21 15:35:08 +1100460function get_release_name_from_branch {
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600461 local branch=$1
Adam Gandelman8f385722014-10-14 15:50:18 -0700462 if [[ $branch =~ "stable/" || $branch =~ "proposed/" ]]; then
Dean Troyerabc7b1d2014-02-12 12:09:22 -0600463 echo ${branch#*/}
464 else
465 echo "master"
466 fi
467}
468
Dean Troyerdff49a22014-01-30 15:37:40 -0600469# git clone only if directory doesn't exist already. Since ``DEST`` might not
470# be owned by the installation user, we create the directory and change the
471# ownership to the proper user.
Dean Troyer50cda692014-07-25 11:57:20 -0500472# Set global ``RECLONE=yes`` to simulate a clone when dest-dir exists
473# Set global ``ERROR_ON_CLONE=True`` to abort execution with an error if the git repo
Dean Troyerdff49a22014-01-30 15:37:40 -0600474# does not exist (default is False, meaning the repo will be cloned).
Sean Dague53753292014-12-04 19:38:15 -0500475# Uses globals ``ERROR_ON_CLONE``, ``OFFLINE``, ``RECLONE``
Dean Troyerdff49a22014-01-30 15:37:40 -0600476# git_clone remote dest-dir branch
477function git_clone {
Dean Troyer50cda692014-07-25 11:57:20 -0500478 local git_remote=$1
479 local git_dest=$2
480 local git_ref=$3
481 local orig_dir=$(pwd)
Jamie Lennox51f0de52014-10-20 16:32:34 +0200482 local git_clone_flags=""
Dean Troyer50cda692014-07-25 11:57:20 -0500483
Sean Dague53753292014-12-04 19:38:15 -0500484 RECLONE=$(trueorfalse False RECLONE)
Kevin Benton59d52f32015-01-17 11:29:12 -0800485 if [[ "${GIT_DEPTH}" -gt 0 ]]; then
Jamie Lennox51f0de52014-10-20 16:32:34 +0200486 git_clone_flags="$git_clone_flags --depth $GIT_DEPTH"
487 fi
488
Dean Troyerdff49a22014-01-30 15:37:40 -0600489 if [[ "$OFFLINE" = "True" ]]; then
490 echo "Running in offline mode, clones already exist"
491 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500492 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600493 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400494 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600495 return
496 fi
497
Dean Troyer50cda692014-07-25 11:57:20 -0500498 if echo $git_ref | egrep -q "^refs"; then
Dean Troyerdff49a22014-01-30 15:37:40 -0600499 # If our branch name is a gerrit style refs/changes/...
Dean Troyer50cda692014-07-25 11:57:20 -0500500 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700501 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
502 echo "The $git_dest project was not found; if this is a gate job, add"
503 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600504 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700505 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200506 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600507 fi
Dean Troyer50cda692014-07-25 11:57:20 -0500508 cd $git_dest
509 git_timed fetch $git_remote $git_ref && git checkout FETCH_HEAD
Dean Troyerdff49a22014-01-30 15:37:40 -0600510 else
511 # do a full clone only if the directory doesn't exist
Dean Troyer50cda692014-07-25 11:57:20 -0500512 if [[ ! -d $git_dest ]]; then
James E. Blairebe63d82015-09-24 07:43:50 -0700513 if [[ "$ERROR_ON_CLONE" = "True" ]]; then
514 echo "The $git_dest project was not found; if this is a gate job, add"
515 echo "the project to the \$PROJECTS variable in the job definition."
Dean Troyerdff49a22014-01-30 15:37:40 -0600516 die $LINENO "Cloning not allowed in this configuration"
James E. Blairebe63d82015-09-24 07:43:50 -0700517 fi
Jamie Lennox51f0de52014-10-20 16:32:34 +0200518 git_timed clone $git_clone_flags $git_remote $git_dest
Dean Troyer50cda692014-07-25 11:57:20 -0500519 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600520 # This checkout syntax works for both branches and tags
Dean Troyer50cda692014-07-25 11:57:20 -0500521 git checkout $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600522 elif [[ "$RECLONE" = "True" ]]; then
523 # if it does exist then simulate what clone does if asked to RECLONE
Dean Troyer50cda692014-07-25 11:57:20 -0500524 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600525 # set the url to pull from and fetch
Dean Troyer50cda692014-07-25 11:57:20 -0500526 git remote set-url origin $git_remote
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100527 git_timed fetch origin
Dean Troyerdff49a22014-01-30 15:37:40 -0600528 # remove the existing ignored files (like pyc) as they cause breakage
529 # (due to the py files having older timestamps than our pyc, so python
530 # thinks the pyc files are correct using them)
Dean Troyer50cda692014-07-25 11:57:20 -0500531 find $git_dest -name '*.pyc' -delete
Dean Troyerdff49a22014-01-30 15:37:40 -0600532
Dean Troyer50cda692014-07-25 11:57:20 -0500533 # handle git_ref accordingly to type (tag, branch)
534 if [[ -n "`git show-ref refs/tags/$git_ref`" ]]; then
535 git_update_tag $git_ref
536 elif [[ -n "`git show-ref refs/heads/$git_ref`" ]]; then
537 git_update_branch $git_ref
538 elif [[ -n "`git show-ref refs/remotes/origin/$git_ref`" ]]; then
539 git_update_remote_branch $git_ref
Dean Troyerdff49a22014-01-30 15:37:40 -0600540 else
Dean Troyer50cda692014-07-25 11:57:20 -0500541 die $LINENO "$git_ref is neither branch nor tag"
Dean Troyerdff49a22014-01-30 15:37:40 -0600542 fi
543
544 fi
545 fi
546
547 # print out the results so we know what change was used in the logs
Dean Troyer50cda692014-07-25 11:57:20 -0500548 cd $git_dest
Dean Troyerdff49a22014-01-30 15:37:40 -0600549 git show --oneline | head -1
Sean Dague64bd0162014-03-12 13:04:22 -0400550 cd $orig_dir
Dean Troyerdff49a22014-01-30 15:37:40 -0600551}
552
Sean Daguecc524062014-10-01 09:06:43 -0400553# A variation on git clone that lets us specify a project by it's
554# actual name, like oslo.config. This is exceptionally useful in the
555# library installation case
556function git_clone_by_name {
557 local name=$1
558 local repo=${GITREPO[$name]}
559 local dir=${GITDIR[$name]}
560 local branch=${GITBRANCH[$name]}
561 git_clone $repo $dir $branch
562}
563
564
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100565# git can sometimes get itself infinitely stuck with transient network
566# errors or other issues with the remote end. This wraps git in a
567# timeout/retry loop and is intended to watch over non-local git
568# processes that might hang. GIT_TIMEOUT, if set, is passed directly
569# to timeout(1); otherwise the default value of 0 maintains the status
570# quo of waiting forever.
571# usage: git_timed <git-command>
Ian Wienandaee18c72014-02-21 15:35:08 +1100572function git_timed {
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100573 local count=0
574 local timeout=0
575
576 if [[ -n "${GIT_TIMEOUT}" ]]; then
577 timeout=${GIT_TIMEOUT}
578 fi
579
580 until timeout -s SIGINT ${timeout} git "$@"; do
581 # 124 is timeout(1)'s special return code when it reached the
582 # timeout; otherwise assume fatal failure
583 if [[ $? -ne 124 ]]; then
584 die $LINENO "git call failed: [git $@]"
585 fi
586
587 count=$(($count + 1))
Sean Daguee4af9292015-04-28 08:57:57 -0400588 warn $LINENO "timeout ${count} for git call: [git $@]"
Ian Wienandd53ad0b2014-02-20 13:55:13 +1100589 if [ $count -eq 3 ]; then
590 die $LINENO "Maximum of 3 git retries reached"
591 fi
592 sleep 5
593 done
594}
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)}
Sean M. Collinsd20435b2015-08-25 19:24:51 -0400645 local 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 -0500646 local ip
647 for ip in $host_ips; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600648 # Attempt to filter out IP addresses that are part of the fixed and
649 # floating range. Note that this method only works if the ``netaddr``
650 # python library is installed. If it is not installed, an error
651 # will be printed and the first IP from the interface will be used.
652 # If that is not correct set ``HOST_IP`` in ``localrc`` to the correct
653 # address.
Brian Haley180f5eb2015-06-16 13:14:31 -0400654 if [[ "$af" == "inet6" ]]; then
655 host_ip=$ip
656 break;
657 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500658 if ! (address_in_net $ip $fixed_range || address_in_net $ip $floating_range); then
659 host_ip=$ip
Dean Troyerdff49a22014-01-30 15:37:40 -0600660 break;
661 fi
662 done
663 fi
664 echo $host_ip
665}
666
Attila Fazekasf71b5002014-05-28 09:52:22 +0200667# Generates hex string from ``size`` byte of pseudo random data
668# generate_hex_string size
669function generate_hex_string {
670 local size=$1
671 hexdump -n "$size" -v -e '/1 "%02x"' /dev/urandom
672}
673
Dean Troyerdff49a22014-01-30 15:37:40 -0600674# Grab a numbered field from python prettytable output
675# Fields are numbered starting with 1
676# Reverse syntax is supported: -1 is the last field, -2 is second to last, etc.
677# get_field field-number
Ian Wienandaee18c72014-02-21 15:35:08 +1100678function get_field {
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500679 local data field
Dean Troyerdff49a22014-01-30 15:37:40 -0600680 while read data; do
681 if [ "$1" -lt 0 ]; then
682 field="(\$(NF$1))"
683 else
684 field="\$$(($1 + 1))"
685 fi
686 echo "$data" | awk -F'[ \t]*\\|[ \t]*' "{print $field}"
687 done
688}
689
yuntongjinf26deea2015-02-28 10:50:34 +0800690# install default policy
691# copy over a default policy.json and policy.d for projects
692function install_default_policy {
693 local project=$1
694 local project_uc=$(echo $1|tr a-z A-Z)
695 local conf_dir="${project_uc}_CONF_DIR"
696 # eval conf dir to get the variable
697 conf_dir="${!conf_dir}"
698 local project_dir="${project_uc}_DIR"
699 # eval project dir to get the variable
700 project_dir="${!project_dir}"
701 local sample_conf_dir="${project_dir}/etc/${project}"
702 local sample_policy_dir="${project_dir}/etc/${project}/policy.d"
703
704 # first copy any policy.json
705 cp -p $sample_conf_dir/policy.json $conf_dir
706 # then optionally copy over policy.d
707 if [[ -d $sample_policy_dir ]]; then
708 cp -r $sample_policy_dir $conf_dir/policy.d
709 fi
710}
711
Dean Troyerdff49a22014-01-30 15:37:40 -0600712# Add a policy to a policy.json file
713# Do nothing if the policy already exists
714# ``policy_add policy_file policy_name policy_permissions``
Ian Wienandaee18c72014-02-21 15:35:08 +1100715function policy_add {
Dean Troyerdff49a22014-01-30 15:37:40 -0600716 local policy_file=$1
717 local policy_name=$2
718 local policy_perm=$3
719
720 if grep -q ${policy_name} ${policy_file}; then
721 echo "Policy ${policy_name} already exists in ${policy_file}"
722 return
723 fi
724
725 # Add a terminating comma to policy lines without one
726 # Remove the closing '}' and all lines following to the end-of-file
727 local tmpfile=$(mktemp)
728 uniq ${policy_file} | sed -e '
729 s/]$/],/
730 /^[}]/,$d
731 ' > ${tmpfile}
732
733 # Append policy and closing brace
734 echo " \"${policy_name}\": ${policy_perm}" >>${tmpfile}
735 echo "}" >>${tmpfile}
736
737 mv ${tmpfile} ${policy_file}
738}
739
Alistair Coles24779f62014-10-15 18:57:59 +0100740# Gets or creates a domain
741# Usage: get_or_create_domain <name> <description>
742function get_or_create_domain {
Ian Wienand11d276c2015-07-02 09:34:34 +1000743 local domain_id
Alistair Coles24779f62014-10-15 18:57:59 +0100744 # Gets domain id
Ian Wienand11d276c2015-07-02 09:34:34 +1000745 domain_id=$(
Alistair Coles24779f62014-10-15 18:57:59 +0100746 # Gets domain id
Steve Martinelli050a0d52015-09-06 22:03:54 +0000747 openstack domain show $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100748 -f value -c id 2>/dev/null ||
749 # Creates new domain
Steve Martinelli050a0d52015-09-06 22:03:54 +0000750 openstack domain create $1 \
Alistair Coles24779f62014-10-15 18:57:59 +0100751 --description "$2" \
752 -f value -c id
753 )
754 echo $domain_id
755}
756
Steve Martinellib74e01c2014-12-18 01:35:35 -0500757# Gets or creates group
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000758# Usage: get_or_create_group <groupname> <domain> [<description>]
Steve Martinellib74e01c2014-12-18 01:35:35 -0500759function get_or_create_group {
Steve Martinellib74e01c2014-12-18 01:35:35 -0500760 local desc="${3:-}"
Ian Wienand11d276c2015-07-02 09:34:34 +1000761 local group_id
Steve Martinellib74e01c2014-12-18 01:35:35 -0500762 # Gets group id
Ian Wienand11d276c2015-07-02 09:34:34 +1000763 group_id=$(
Steve Martinellib74e01c2014-12-18 01:35:35 -0500764 # Creates new group with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000765 openstack group create $1 \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000766 --domain $2 --description "$desc" --or-show \
Steve Martinellib74e01c2014-12-18 01:35:35 -0500767 -f value -c id
768 )
769 echo $group_id
770}
771
Bartosz Górski0abde392014-02-28 14:15:19 +0100772# Gets or creates user
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000773# Usage: get_or_create_user <username> <password> <domain> [<email>]
Bartosz Górski0abde392014-02-28 14:15:19 +0100774function get_or_create_user {
Ian Wienand11d276c2015-07-02 09:34:34 +1000775 local user_id
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000776 if [[ ! -z "$4" ]]; then
777 local email="--email=$4"
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200778 else
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500779 local email=""
Gael Chamoulaud6dd8a8b2014-07-22 01:12:12 +0200780 fi
Bartosz Górski0abde392014-02-28 14:15:19 +0100781 # Gets user id
Ian Wienand11d276c2015-07-02 09:34:34 +1000782 user_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500783 # Creates new user with --or-show
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000784 openstack user create \
Bartosz Górski0abde392014-02-28 14:15:19 +0100785 $1 \
786 --password "$2" \
Jamie Lennox9d7e7762015-05-29 01:08:53 +0000787 --domain=$3 \
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500788 $email \
Steve Martinelli245daa22014-11-14 02:17:22 -0500789 --or-show \
Bartosz Górski0abde392014-02-28 14:15:19 +0100790 -f value -c id
791 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500792 echo $user_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100793}
794
795# Gets or creates project
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000796# Usage: get_or_create_project <name> <domain>
Bartosz Górski0abde392014-02-28 14:15:19 +0100797function get_or_create_project {
Ian Wienand11d276c2015-07-02 09:34:34 +1000798 local project_id
799 project_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500800 # Creates new project with --or-show
Steve Martinelli050a0d52015-09-06 22:03:54 +0000801 openstack project create $1 \
Jamie Lennoxb632c9e2015-05-28 23:36:15 +0000802 --domain=$2 \
803 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100804 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500805 echo $project_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100806}
807
808# Gets or creates role
809# Usage: get_or_create_role <name>
810function get_or_create_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000811 local role_id
812 role_id=$(
Steve Martinelli245daa22014-11-14 02:17:22 -0500813 # Creates role with --or-show
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000814 openstack role create $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000815 --or-show -f value -c id
Bartosz Górski0abde392014-02-28 14:15:19 +0100816 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500817 echo $role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100818}
819
Jamie Lennox9b215db2015-02-10 18:19:57 +1100820# Gets or adds user role to project
821# Usage: get_or_add_user_project_role <role> <user> <project>
822function get_or_add_user_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000823 local user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100824 # Gets user role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000825 user_role_id=$(openstack role list \
Steve Martinelli5541a612015-01-19 15:58:49 -0500826 --user $2 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100827 --column "ID" \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000828 --project $3 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100829 --column "Name" \
830 | grep " $1 " | get_field 1)
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500831 if [[ -z "$user_role_id" ]]; then
Roxana Gherle50821be2015-09-22 10:52:46 -0700832 # Adds role to user and get it
833 openstack role add $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100834 --user $2 \
Steve Martinelli050a0d52015-09-06 22:03:54 +0000835 --project $3
Roxana Gherle50821be2015-09-22 10:52:46 -0700836 user_role_id=$(openstack role list \
837 --user $2 \
Roxana Gherle50821be2015-09-22 10:52:46 -0700838 --column "ID" \
839 --project $3 \
840 --column "Name" \
841 | grep " $1 " | get_field 1)
Bartosz Górski0abde392014-02-28 14:15:19 +0100842 fi
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500843 echo $user_role_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100844}
845
Steve Martinelli4599fd12015-03-12 21:30:58 -0400846# Gets or adds group role to project
847# Usage: get_or_add_group_project_role <role> <group> <project>
848function get_or_add_group_project_role {
Ian Wienand11d276c2015-07-02 09:34:34 +1000849 local group_role_id
Steve Martinelli4599fd12015-03-12 21:30:58 -0400850 # Gets group role id
Ian Wienand11d276c2015-07-02 09:34:34 +1000851 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400852 --group $2 \
853 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000854 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400855 if [[ -z "$group_role_id" ]]; then
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000856 # Adds role to group and get it
857 openstack role add $1 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000858 --group $2 \
859 --project $3
860 group_role_id=$(openstack role list \
Steve Martinelli4599fd12015-03-12 21:30:58 -0400861 --group $2 \
862 --project $3 \
Jamie Lennox72ce6ac2015-07-02 09:19:01 +1000863 -c "ID" -f value)
Steve Martinelli4599fd12015-03-12 21:30:58 -0400864 fi
865 echo $group_role_id
866}
867
Bartosz Górski0abde392014-02-28 14:15:19 +0100868# Gets or creates service
869# Usage: get_or_create_service <name> <type> <description>
870function get_or_create_service {
Ian Wienand11d276c2015-07-02 09:34:34 +1000871 local service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100872 # Gets service id
Ian Wienand11d276c2015-07-02 09:34:34 +1000873 service_id=$(
Bartosz Górski0abde392014-02-28 14:15:19 +0100874 # Gets service id
Jamie Lennoxaedb8b92015-07-02 17:39:07 +1000875 openstack service show $2 -f value -c id 2>/dev/null ||
Bartosz Górski0abde392014-02-28 14:15:19 +0100876 # Creates new service if not exists
877 openstack service create \
Steve Martinelli789af5c2015-01-19 16:11:44 -0500878 $2 \
879 --name $1 \
Bartosz Górski0abde392014-02-28 14:15:19 +0100880 --description="$3" \
881 -f value -c id
882 )
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500883 echo $service_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100884}
885
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000886# Create an endpoint with a specific interface
887# Usage: _get_or_create_endpoint_with_interface <service> <interface> <url> <region>
888function _get_or_create_endpoint_with_interface {
Ian Wienand11d276c2015-07-02 09:34:34 +1000889 local endpoint_id
Daniel Gonzalez1991e752015-08-11 19:34:22 +0200890 # TODO(dgonzalez): The check of the region name, as done in the grep
891 # statement below, exists only because keystone does currently
892 # not allow filtering the region name when listing endpoints. If keystone
893 # gets support for this, the check for the region name can be removed.
894 # Related bug in keystone: https://bugs.launchpad.net/keystone/+bug/1482772
Ian Wienand11d276c2015-07-02 09:34:34 +1000895 endpoint_id=$(openstack endpoint list \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000896 --service $1 \
897 --interface $2 \
898 --region $4 \
Daniel Gonzalez1991e752015-08-11 19:34:22 +0200899 -c ID -c Region -f value | grep $4 | cut -f 1 -d " ")
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500900 if [[ -z "$endpoint_id" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100901 # Creates new endpoint
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500902 endpoint_id=$(openstack endpoint create \
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000903 $1 $2 $3 --region $4 -f value -c id)
Bartosz Górski0abde392014-02-28 14:15:19 +0100904 fi
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000905
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500906 echo $endpoint_id
Bartosz Górski0abde392014-02-28 14:15:19 +0100907}
Dean Troyerdff49a22014-01-30 15:37:40 -0600908
Jamie Lennoxb17ad752015-05-29 06:04:47 +0000909# Gets or creates endpoint
910# Usage: get_or_create_endpoint <service> <region> <publicurl> <adminurl> <internalurl>
911function get_or_create_endpoint {
912 # NOTE(jamielennnox): when converting to v3 endpoint creation we go from
913 # creating one endpoint with multiple urls to multiple endpoints each with
914 # a different interface. To maintain the existing function interface we
915 # create 3 endpoints and return the id of the public one. In reality
916 # returning the public id will not make a lot of difference as there are no
917 # scenarios currently that use the returned id. Ideally this behaviour
918 # should be pushed out to the service setups and let them create the
919 # endpoints they need.
920 local public_id=$(_get_or_create_endpoint_with_interface $1 public $3 $2)
921 _get_or_create_endpoint_with_interface $1 admin $4 $2
922 _get_or_create_endpoint_with_interface $1 internal $5 $2
923
924 # return the public id to indicate success, and this is the endpoint most likely wanted
925 echo $public_id
926}
927
928# Get a URL from the identity service
929# Usage: get_endpoint_url <service> <interface>
930function get_endpoint_url {
931 echo $(openstack endpoint list \
932 --service $1 --interface $2 \
933 --os-url $KEYSTONE_SERVICE_URI_V3 \
934 --os-identity-api-version=3 \
935 -c URL -f value)
936}
937
Dean Troyerd5dfa4c2014-07-25 11:13:11 -0500938
Dean Troyerdff49a22014-01-30 15:37:40 -0600939# Package Functions
940# =================
941
942# _get_package_dir
Ian Wienandaee18c72014-02-21 15:35:08 +1100943function _get_package_dir {
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800944 local base_dir=$1
Dean Troyerdff49a22014-01-30 15:37:40 -0600945 local pkg_dir
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800946
947 if [[ -z "$base_dir" ]]; then
948 base_dir=$FILES
949 fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600950 if is_ubuntu; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800951 pkg_dir=$base_dir/debs
Dean Troyerdff49a22014-01-30 15:37:40 -0600952 elif is_fedora; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800953 pkg_dir=$base_dir/rpms
Dean Troyerdff49a22014-01-30 15:37:40 -0600954 elif is_suse; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800955 pkg_dir=$base_dir/rpms-suse
Dean Troyerdff49a22014-01-30 15:37:40 -0600956 else
957 exit_distro_not_supported "list of packages"
958 fi
959 echo "$pkg_dir"
960}
961
962# Wrapper for ``apt-get`` to set cache and proxy environment variables
963# Uses globals ``OFFLINE``, ``*_proxy``
964# apt_get operation package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +1100965function apt_get {
Sean Dague45917cc2014-02-24 16:09:14 -0500966 local xtrace=$(set +o | grep xtrace)
967 set +o xtrace
968
Dean Troyerdff49a22014-01-30 15:37:40 -0600969 [[ "$OFFLINE" = "True" || -z "$@" ]] && return
970 local sudo="sudo"
971 [[ "$(id -u)" = "0" ]] && sudo="env"
Sean Dague45917cc2014-02-24 16:09:14 -0500972
973 $xtrace
Sean Dague53753292014-12-04 19:38:15 -0500974
Dean Troyerdff49a22014-01-30 15:37:40 -0600975 $sudo DEBIAN_FRONTEND=noninteractive \
Sean Dague53753292014-12-04 19:38:15 -0500976 http_proxy=${http_proxy:-} https_proxy=${https_proxy:-} \
977 no_proxy=${no_proxy:-} \
Dean Troyerdff49a22014-01-30 15:37:40 -0600978 apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@"
979}
980
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800981function _parse_package_files {
982 local files_to_parse=$@
Dean Troyerdff49a22014-01-30 15:37:40 -0600983
Dean Troyerdff49a22014-01-30 15:37:40 -0600984 if [[ -z "$DISTRO" ]]; then
985 GetDistro
986 fi
Dean Troyerdff49a22014-01-30 15:37:40 -0600987
Adam Gandelman7ca90cd2015-03-04 17:25:07 -0800988 for fname in ${files_to_parse}; do
Dean Troyerdff49a22014-01-30 15:37:40 -0600989 local OIFS line package distros distro
990 [[ -e $fname ]] || continue
991
992 OIFS=$IFS
993 IFS=$'\n'
994 for line in $(<${fname}); do
995 if [[ $line =~ "NOPRIME" ]]; then
996 continue
997 fi
998
999 # Assume we want this package
1000 package=${line%#*}
1001 inst_pkg=1
1002
1003 # Look for # dist:xxx in comment
1004 if [[ $line =~ (.*)#.*dist:([^ ]*) ]]; then
1005 # We are using BASH regexp matching feature.
1006 package=${BASH_REMATCH[1]}
1007 distros=${BASH_REMATCH[2]}
1008 # In bash ${VAR,,} will lowecase VAR
1009 # Look for a match in the distro list
1010 if [[ ! ${distros,,} =~ ${DISTRO,,} ]]; then
1011 # If no match then skip this package
1012 inst_pkg=0
1013 fi
1014 fi
1015
Dean Troyerdff49a22014-01-30 15:37:40 -06001016 if [[ $inst_pkg = 1 ]]; then
1017 echo $package
1018 fi
1019 done
1020 IFS=$OIFS
1021 done
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001022}
1023
1024# get_packages() collects a list of package names of any type from the
1025# prerequisite files in ``files/{debs|rpms}``. The list is intended
1026# to be passed to a package installer such as apt or yum.
1027#
1028# Only packages required for the services in 1st argument will be
1029# included. Two bits of metadata are recognized in the prerequisite files:
1030#
1031# - ``# NOPRIME`` defers installation to be performed later in `stack.sh`
1032# - ``# dist:DISTRO`` or ``dist:DISTRO1,DISTRO2`` limits the selection
1033# of the package to the distros listed. The distro names are case insensitive.
1034function get_packages {
1035 local xtrace=$(set +o | grep xtrace)
1036 set +o xtrace
1037 local services=$@
1038 local package_dir=$(_get_package_dir)
1039 local file_to_parse=""
1040 local service=""
1041
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001042 if [[ -z "$package_dir" ]]; then
1043 echo "No package directory supplied"
1044 return 1
1045 fi
1046 for service in ${services//,/ }; do
1047 # Allow individual services to specify dependencies
1048 if [[ -e ${package_dir}/${service} ]]; then
1049 file_to_parse="${file_to_parse} ${package_dir}/${service}"
1050 fi
1051 # NOTE(sdague) n-api needs glance for now because that's where
1052 # glance client is
1053 if [[ $service == n-api ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001054 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001055 file_to_parse="${file_to_parse} ${package_dir}/nova"
1056 fi
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001057 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001058 file_to_parse="${file_to_parse} ${package_dir}/glance"
1059 fi
1060 elif [[ $service == c-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001061 if [[ ! $file_to_parse =~ $package_dir/cinder ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001062 file_to_parse="${file_to_parse} ${package_dir}/cinder"
1063 fi
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001064 elif [[ $service == s-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001065 if [[ ! $file_to_parse =~ $package_dir/swift ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001066 file_to_parse="${file_to_parse} ${package_dir}/swift"
1067 fi
1068 elif [[ $service == n-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001069 if [[ ! $file_to_parse =~ $package_dir/nova ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001070 file_to_parse="${file_to_parse} ${package_dir}/nova"
1071 fi
1072 elif [[ $service == g-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001073 if [[ ! $file_to_parse =~ $package_dir/glance ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001074 file_to_parse="${file_to_parse} ${package_dir}/glance"
1075 fi
1076 elif [[ $service == key* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001077 if [[ ! $file_to_parse =~ $package_dir/keystone ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001078 file_to_parse="${file_to_parse} ${package_dir}/keystone"
1079 fi
1080 elif [[ $service == q-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001081 if [[ ! $file_to_parse =~ $package_dir/neutron ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001082 file_to_parse="${file_to_parse} ${package_dir}/neutron"
1083 fi
1084 elif [[ $service == ir-* ]]; then
Ryan Hsu6f3f3102015-03-19 16:26:45 -07001085 if [[ ! $file_to_parse =~ $package_dir/ironic ]]; then
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001086 file_to_parse="${file_to_parse} ${package_dir}/ironic"
1087 fi
1088 fi
1089 done
1090 echo "$(_parse_package_files $file_to_parse)"
1091 $xtrace
1092}
1093
1094# get_plugin_packages() collects a list of package names of any type from a
1095# plugin's prerequisite files in ``$PLUGIN/devstack/files/{debs|rpms}``. The
1096# list is intended to be passed to a package installer such as apt or yum.
1097#
1098# Only packages required for enabled and collected plugins will included.
1099#
Dean Troyerdc97cb72015-03-28 08:20:50 -05001100# The same metadata used in the main DevStack prerequisite files may be used
Adam Gandelman7ca90cd2015-03-04 17:25:07 -08001101# in these prerequisite files, see get_packages() for more info.
1102function get_plugin_packages {
1103 local xtrace=$(set +o | grep xtrace)
1104 set +o xtrace
1105 local files_to_parse=""
1106 local package_dir=""
1107 for plugin in ${DEVSTACK_PLUGINS//,/ }; do
1108 local package_dir="$(_get_package_dir ${GITDIR[$plugin]}/devstack/files)"
1109 files_to_parse+="$package_dir/$plugin"
1110 done
1111 echo "$(_parse_package_files $files_to_parse)"
Sean Dague45917cc2014-02-24 16:09:14 -05001112 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001113}
1114
1115# Distro-agnostic package installer
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001116# Uses globals ``NO_UPDATE_REPOS``, ``REPOS_UPDATED``, ``RETRY_UPDATE``
Dean Troyerdff49a22014-01-30 15:37:40 -06001117# install_package package [package ...]
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001118function update_package_repo {
Sean Dague53753292014-12-04 19:38:15 -05001119 NO_UPDATE_REPOS=${NO_UPDATE_REPOS:-False}
1120 REPOS_UPDATED=${REPOS_UPDATED:-False}
1121 RETRY_UPDATE=${RETRY_UPDATE:-False}
1122
Paul Linchpiner9e179742014-07-13 22:23:00 -07001123 if [[ "$NO_UPDATE_REPOS" = "True" ]]; then
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001124 return 0
1125 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001126
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001127 if is_ubuntu; then
1128 local xtrace=$(set +o | grep xtrace)
1129 set +o xtrace
1130 if [[ "$REPOS_UPDATED" != "True" || "$RETRY_UPDATE" = "True" ]]; then
1131 # if there are transient errors pulling the updates, that's fine.
1132 # It may be secondary repositories that we don't really care about.
1133 apt_get update || /bin/true
1134 REPOS_UPDATED=True
1135 fi
Sean Dague45917cc2014-02-24 16:09:14 -05001136 $xtrace
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001137 fi
1138}
1139
1140function real_install_package {
1141 if is_ubuntu; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001142 apt_get install "$@"
1143 elif is_fedora; then
1144 yum_install "$@"
1145 elif is_suse; then
1146 zypper_install "$@"
1147 else
1148 exit_distro_not_supported "installing packages"
1149 fi
1150}
1151
Monty Taylor5cc6d2c2014-06-06 08:45:16 -04001152# Distro-agnostic package installer
1153# install_package package [package ...]
1154function install_package {
1155 update_package_repo
1156 real_install_package $@ || RETRY_UPDATE=True update_package_repo && real_install_package $@
1157}
1158
Dean Troyerdff49a22014-01-30 15:37:40 -06001159# Distro-agnostic function to tell if a package is installed
1160# is_package_installed package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001161function is_package_installed {
Dean Troyerdff49a22014-01-30 15:37:40 -06001162 if [[ -z "$@" ]]; then
1163 return 1
1164 fi
1165
1166 if [[ -z "$os_PACKAGE" ]]; then
1167 GetOSVersion
1168 fi
1169
1170 if [[ "$os_PACKAGE" = "deb" ]]; then
1171 dpkg -s "$@" > /dev/null 2> /dev/null
1172 elif [[ "$os_PACKAGE" = "rpm" ]]; then
1173 rpm --quiet -q "$@"
1174 else
1175 exit_distro_not_supported "finding if a package is installed"
1176 fi
1177}
1178
1179# Distro-agnostic package uninstaller
1180# uninstall_package package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001181function uninstall_package {
Dean Troyerdff49a22014-01-30 15:37:40 -06001182 if is_ubuntu; then
1183 apt_get purge "$@"
1184 elif is_fedora; then
Ian Wienand36298ee2015-02-04 10:29:31 +11001185 sudo ${YUM:-yum} remove -y "$@" ||:
Dean Troyerdff49a22014-01-30 15:37:40 -06001186 elif is_suse; then
1187 sudo zypper rm "$@"
1188 else
1189 exit_distro_not_supported "uninstalling packages"
1190 fi
1191}
1192
1193# Wrapper for ``yum`` to set proxy environment variables
Daniel P. Berrange63d25d92014-12-09 15:21:22 +00001194# Uses globals ``OFFLINE``, ``*_proxy``, ``YUM``
Dean Troyerdff49a22014-01-30 15:37:40 -06001195# yum_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001196function yum_install {
Dean Troyerdff49a22014-01-30 15:37:40 -06001197 [[ "$OFFLINE" = "True" ]] && return
1198 local sudo="sudo"
1199 [[ "$(id -u)" = "0" ]] && sudo="env"
Ian Wienandb27f16d2014-02-28 14:29:02 +11001200
1201 # The manual check for missing packages is because yum -y assumes
1202 # missing packages are OK. See
1203 # https://bugzilla.redhat.com/show_bug.cgi?id=965567
Ian Wienandfdf00f22015-03-13 11:50:02 +11001204 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}" \
1205 no_proxy="${no_proxy:-}" \
Ian Wienand36298ee2015-02-04 10:29:31 +11001206 ${YUM:-yum} install -y "$@" 2>&1 | \
Ian Wienandb27f16d2014-02-28 14:29:02 +11001207 awk '
1208 BEGIN { fail=0 }
1209 /No package/ { fail=1 }
1210 { print }
1211 END { exit fail }' || \
1212 die $LINENO "Missing packages detected"
1213
1214 # also ensure we catch a yum failure
1215 if [[ ${PIPESTATUS[0]} != 0 ]]; then
Ian Wienand36298ee2015-02-04 10:29:31 +11001216 die $LINENO "${YUM:-yum} install failure"
Ian Wienandb27f16d2014-02-28 14:29:02 +11001217 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001218}
1219
1220# zypper wrapper to set arguments correctly
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001221# Uses globals ``OFFLINE``, ``*_proxy``
Dean Troyerdff49a22014-01-30 15:37:40 -06001222# zypper_install package [package ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001223function zypper_install {
Dean Troyerdff49a22014-01-30 15:37:40 -06001224 [[ "$OFFLINE" = "True" ]] && return
1225 local sudo="sudo"
1226 [[ "$(id -u)" = "0" ]] && sudo="env"
Ian Wienandfdf00f22015-03-13 11:50:02 +11001227 $sudo http_proxy="${http_proxy:-}" https_proxy="${https_proxy:-}" \
1228 no_proxy="${no_proxy:-}" \
Dean Troyerdff49a22014-01-30 15:37:40 -06001229 zypper --non-interactive install --auto-agree-with-licenses "$@"
1230}
1231
1232
1233# Process Functions
1234# =================
1235
1236# _run_process() is designed to be backgrounded by run_process() to simulate a
1237# fork. It includes the dirty work of closing extra filehandles and preparing log
1238# files to produce the same logs as screen_it(). The log filename is derived
Dean Troyerdde41d02014-12-09 17:47:57 -06001239# from the service name.
1240# Uses globals ``CURRENT_LOG_TIME``, ``LOGDIR``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001241# If an optional group is provided sg will be used to set the group of
1242# the command.
1243# _run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001244function _run_process {
Sean Dague6e137ab2015-04-29 08:22:24 -04001245 # disable tracing through the exec redirects, it's just confusing in the logs.
1246 xtrace=$(set +o | grep xtrace)
1247 set +o xtrace
1248
Dean Troyerdff49a22014-01-30 15:37:40 -06001249 local service=$1
1250 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001251 local group=$3
Dean Troyerdff49a22014-01-30 15:37:40 -06001252
1253 # Undo logging redirections and close the extra descriptors
1254 exec 1>&3
1255 exec 2>&3
1256 exec 3>&-
1257 exec 6>&-
1258
Dean Troyerdde41d02014-12-09 17:47:57 -06001259 local real_logfile="${LOGDIR}/${service}.log.${CURRENT_LOG_TIME}"
1260 if [[ -n ${LOGDIR} ]]; then
1261 exec 1>&"$real_logfile" 2>&1
1262 ln -sf "$real_logfile" ${LOGDIR}/${service}.log
1263 if [[ -n ${SCREEN_LOGDIR} ]]; then
1264 # Drop the backward-compat symlink
1265 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${service}.log
1266 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001267
1268 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1269 export PYTHONUNBUFFERED=1
1270 fi
1271
Sean Dague6e137ab2015-04-29 08:22:24 -04001272 # reenable xtrace before we do *real* work
1273 $xtrace
1274
Dean Troyer3159a822014-08-27 14:13:58 -05001275 # Run under ``setsid`` to force the process to become a session and group leader.
1276 # The pid saved can be used with pkill -g to get the entire process group.
Chris Dent2f27a0e2014-09-09 13:46:02 +01001277 if [[ -n "$group" ]]; then
1278 setsid sg $group "$command" & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1279 else
1280 setsid $command & echo $! >$SERVICE_DIR/$SCREEN_NAME/$service.pid
1281 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001282
1283 # Just silently exit this process
1284 exit 0
Dean Troyerdff49a22014-01-30 15:37:40 -06001285}
1286
1287# Helper to remove the ``*.failure`` files under ``$SERVICE_DIR/$SCREEN_NAME``.
1288# This is used for ``service_check`` when all the ``screen_it`` are called finished
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001289# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001290# init_service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001291function init_service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001292 SCREEN_NAME=${SCREEN_NAME:-stack}
1293 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1294
1295 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1296 mkdir -p "$SERVICE_DIR/$SCREEN_NAME"
1297 fi
1298
1299 rm -f "$SERVICE_DIR/$SCREEN_NAME"/*.failure
1300}
1301
1302# Find out if a process exists by partial name.
1303# is_running name
Ian Wienandaee18c72014-02-21 15:35:08 +11001304function is_running {
Dean Troyerdff49a22014-01-30 15:37:40 -06001305 local name=$1
1306 ps auxw | grep -v grep | grep ${name} > /dev/null
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001307 local exitcode=$?
Dean Troyerdff49a22014-01-30 15:37:40 -06001308 # some times I really hate bash reverse binary logic
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001309 return $exitcode
Dean Troyerdff49a22014-01-30 15:37:40 -06001310}
1311
Dean Troyer3159a822014-08-27 14:13:58 -05001312# Run a single service under screen or directly
1313# If the command includes shell metachatacters (;<>*) it must be run using a shell
Chris Dent2f27a0e2014-09-09 13:46:02 +01001314# If an optional group is provided sg will be used to run the
1315# command as that group.
1316# run_process service "command-line" [group]
Ian Wienandaee18c72014-02-21 15:35:08 +11001317function run_process {
Dean Troyerdff49a22014-01-30 15:37:40 -06001318 local service=$1
1319 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001320 local group=$3
Dean Troyerdff49a22014-01-30 15:37:40 -06001321
Dean Troyer3159a822014-08-27 14:13:58 -05001322 if is_service_enabled $service; then
1323 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001324 screen_process "$service" "$command" "$group"
Dean Troyer3159a822014-08-27 14:13:58 -05001325 else
1326 # Spawn directly without screen
Chris Dent2f27a0e2014-09-09 13:46:02 +01001327 _run_process "$service" "$command" "$group" &
Dean Troyer3159a822014-08-27 14:13:58 -05001328 fi
1329 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001330}
1331
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001332# Helper to launch a process in a named screen
Dean Troyerdde41d02014-12-09 17:47:57 -06001333# Uses globals ``CURRENT_LOG_TIME``, ```LOGDIR``, ``SCREEN_LOGDIR``, `SCREEN_NAME``,
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001334# ``SERVICE_DIR``, ``USE_SCREEN``
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001335# screen_process name "command-line" [group]
Chris Dent2f27a0e2014-09-09 13:46:02 +01001336# Run a command in a shell in a screen window, if an optional group
1337# is provided, use sg to set the group of the command.
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001338function screen_process {
1339 local name=$1
Dean Troyer3159a822014-08-27 14:13:58 -05001340 local command="$2"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001341 local group=$3
Dean Troyer3159a822014-08-27 14:13:58 -05001342
Sean Dagueea22a4f2014-06-27 15:21:41 -04001343 SCREEN_NAME=${SCREEN_NAME:-stack}
1344 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001345 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyerdff49a22014-01-30 15:37:40 -06001346
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001347 screen -S $SCREEN_NAME -X screen -t $name
Dean Troyerdff49a22014-01-30 15:37:40 -06001348
Dean Troyerdde41d02014-12-09 17:47:57 -06001349 local real_logfile="${LOGDIR}/${name}.log.${CURRENT_LOG_TIME}"
1350 echo "LOGDIR: $LOGDIR"
1351 echo "SCREEN_LOGDIR: $SCREEN_LOGDIR"
1352 echo "log: $real_logfile"
1353 if [[ -n ${LOGDIR} ]]; then
1354 screen -S $SCREEN_NAME -p $name -X logfile "$real_logfile"
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001355 screen -S $SCREEN_NAME -p $name -X log on
Dean Troyerdde41d02014-12-09 17:47:57 -06001356 ln -sf "$real_logfile" ${LOGDIR}/${name}.log
1357 if [[ -n ${SCREEN_LOGDIR} ]]; then
1358 # Drop the backward-compat symlink
1359 ln -sf "$real_logfile" ${SCREEN_LOGDIR}/screen-${1}.log
1360 fi
Dean Troyerdff49a22014-01-30 15:37:40 -06001361 fi
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001362
1363 # sleep to allow bash to be ready to be send the command - we are
1364 # creating a new window in screen and then sends characters, so if
Sean Dague4d7ee092015-04-07 10:40:49 -04001365 # bash isn't running by the time we send the command, nothing
1366 # happens. This sleep was added originally to handle gate runs
1367 # where we needed this to be at least 3 seconds to pass
1368 # consistently on slow clouds. Now this is configurable so that we
1369 # can determine a reasonable value for the local case which should
1370 # be much smaller.
1371 sleep ${SCREEN_SLEEP:-3}
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001372
1373 NL=`echo -ne '\015'`
1374 # This fun command does the following:
1375 # - the passed server command is backgrounded
1376 # - the pid of the background process is saved in the usual place
1377 # - the server process is brought back to the foreground
1378 # - if the server process exits prematurely the fg command errors
1379 # and a message is written to stdout and the process failure file
1380 #
1381 # The pid saved can be used in stop_process() as a process group
1382 # id to kill off all child processes
1383 if [[ -n "$group" ]]; then
1384 command="sg $group '$command'"
1385 fi
Ian Wienandb28b2702015-04-16 08:43:43 +10001386
1387 # Append the process to the screen rc file
1388 screen_rc "$name" "$command"
1389
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001390 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 -06001391}
1392
1393# Screen rc file builder
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001394# Uses globals ``SCREEN_NAME``, ``SCREENRC``
Dean Troyerdff49a22014-01-30 15:37:40 -06001395# screen_rc service "command-line"
1396function screen_rc {
1397 SCREEN_NAME=${SCREEN_NAME:-stack}
1398 SCREENRC=$TOP_DIR/$SCREEN_NAME-screenrc
1399 if [[ ! -e $SCREENRC ]]; then
1400 # Name the screen session
1401 echo "sessionname $SCREEN_NAME" > $SCREENRC
1402 # Set a reasonable statusbar
1403 echo "hardstatus alwayslastline '$SCREEN_HARDSTATUS'" >> $SCREENRC
1404 # Some distributions override PROMPT_COMMAND for the screen terminal type - turn that off
1405 echo "setenv PROMPT_COMMAND /bin/true" >> $SCREENRC
1406 echo "screen -t shell bash" >> $SCREENRC
1407 fi
1408 # If this service doesn't already exist in the screenrc file
1409 if ! grep $1 $SCREENRC 2>&1 > /dev/null; then
1410 NL=`echo -ne '\015'`
1411 echo "screen -t $1 bash" >> $SCREENRC
1412 echo "stuff \"$2$NL\"" >> $SCREENRC
1413
Dean Troyerdde41d02014-12-09 17:47:57 -06001414 if [[ -n ${LOGDIR} ]]; then
1415 echo "logfile ${LOGDIR}/${1}.log.${CURRENT_LOG_TIME}" >>$SCREENRC
Dean Troyerdff49a22014-01-30 15:37:40 -06001416 echo "log on" >>$SCREENRC
1417 fi
1418 fi
1419}
1420
1421# Stop a service in screen
1422# If a PID is available use it, kill the whole process group via TERM
1423# If screen is being used kill the screen window; this will catch processes
1424# that did not leave a PID behind
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001425# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``, ``USE_SCREEN``
Chris Dent2f27a0e2014-09-09 13:46:02 +01001426# screen_stop_service service
Dean Troyer3159a822014-08-27 14:13:58 -05001427function screen_stop_service {
1428 local service=$1
1429
Dean Troyerdff49a22014-01-30 15:37:40 -06001430 SCREEN_NAME=${SCREEN_NAME:-stack}
1431 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001432 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyerdff49a22014-01-30 15:37:40 -06001433
Dean Troyer3159a822014-08-27 14:13:58 -05001434 if is_service_enabled $service; then
1435 # Clean up the screen window
Attila Fazekasf750a6f2015-07-01 12:17:35 +02001436 screen -S $SCREEN_NAME -p $service -X kill || true
Dean Troyer3159a822014-08-27 14:13:58 -05001437 fi
1438}
1439
1440# Stop a service process
1441# If a PID is available use it, kill the whole process group via TERM
1442# If screen is being used kill the screen window; this will catch processes
1443# that did not leave a PID behind
1444# Uses globals ``SERVICE_DIR``, ``USE_SCREEN``
1445# stop_process service
1446function stop_process {
1447 local service=$1
1448
1449 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
Sean Dague53753292014-12-04 19:38:15 -05001450 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Dean Troyer3159a822014-08-27 14:13:58 -05001451
1452 if is_service_enabled $service; then
Dean Troyerdff49a22014-01-30 15:37:40 -06001453 # Kill via pid if we have one available
Dean Troyer3159a822014-08-27 14:13:58 -05001454 if [[ -r $SERVICE_DIR/$SCREEN_NAME/$service.pid ]]; then
1455 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid)
Dan Smithce7246a2015-04-23 09:41:06 -07001456 # oslo.service tends to stop actually shutting down
1457 # reliably in between releases because someone believes it
1458 # is dying too early due to some inflight work they
1459 # have. This is a tension. It happens often enough we're
1460 # going to just account for it in devstack and assume it
1461 # doesn't work.
1462 #
1463 # Set OSLO_SERVICE_WORKS=True to skip this block
1464 if [[ -z "$OSLO_SERVICE_WORKS" ]]; then
1465 # TODO(danms): Remove this double-kill when we have
1466 # this fixed in all services:
1467 # https://bugs.launchpad.net/oslo-incubator/+bug/1446583
1468 sleep 1
1469 # /bin/true becakse pkill on a non existant process returns an error
1470 pkill -g $(cat $SERVICE_DIR/$SCREEN_NAME/$service.pid) || /bin/true
1471 fi
Dean Troyer3159a822014-08-27 14:13:58 -05001472 rm $SERVICE_DIR/$SCREEN_NAME/$service.pid
Dean Troyerdff49a22014-01-30 15:37:40 -06001473 fi
1474 if [[ "$USE_SCREEN" = "True" ]]; then
1475 # Clean up the screen window
Dean Troyer3159a822014-08-27 14:13:58 -05001476 screen_stop_service $service
Dean Troyerdff49a22014-01-30 15:37:40 -06001477 fi
1478 fi
1479}
1480
1481# Helper to get the status of each running service
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001482# Uses globals ``SCREEN_NAME``, ``SERVICE_DIR``
Dean Troyerdff49a22014-01-30 15:37:40 -06001483# service_check
Ian Wienandaee18c72014-02-21 15:35:08 +11001484function service_check {
Dean Troyerdff49a22014-01-30 15:37:40 -06001485 local service
1486 local failures
1487 SCREEN_NAME=${SCREEN_NAME:-stack}
1488 SERVICE_DIR=${SERVICE_DIR:-${DEST}/status}
1489
1490
1491 if [[ ! -d "$SERVICE_DIR/$SCREEN_NAME" ]]; then
1492 echo "No service status directory found"
1493 return
1494 fi
1495
Wei Jiangange3340f12015-09-21 17:52:14 +08001496 # Check if there is any failure flag file under $SERVICE_DIR/$SCREEN_NAME
Sean Dague09bd7c82014-02-03 08:35:26 +09001497 # make this -o errexit safe
1498 failures=`ls "$SERVICE_DIR/$SCREEN_NAME"/*.failure 2>/dev/null || /bin/true`
Dean Troyerdff49a22014-01-30 15:37:40 -06001499
1500 for service in $failures; do
1501 service=`basename $service`
1502 service=${service%.failure}
1503 echo "Error: Service $service is not running"
1504 done
1505
1506 if [ -n "$failures" ]; then
Sean Dague12379222014-02-27 17:16:46 -05001507 die $LINENO "More details about the above errors can be found with screen, with ./rejoin-stack.sh"
Dean Troyerdff49a22014-01-30 15:37:40 -06001508 fi
1509}
1510
Chris Dent2f27a0e2014-09-09 13:46:02 +01001511# Tail a log file in a screen if USE_SCREEN is true.
1512function tail_log {
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001513 local name=$1
Chris Dent2f27a0e2014-09-09 13:46:02 +01001514 local logfile=$2
1515
Sean Dague53753292014-12-04 19:38:15 -05001516 USE_SCREEN=$(trueorfalse True USE_SCREEN)
Chris Dent2f27a0e2014-09-09 13:46:02 +01001517 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001518 screen_process "$name" "sudo tail -f $logfile"
Chris Dent2f27a0e2014-09-09 13:46:02 +01001519 fi
1520}
1521
Dean Troyerdff49a22014-01-30 15:37:40 -06001522
Dean Troyer3159a822014-08-27 14:13:58 -05001523# Deprecated Functions
1524# --------------------
1525
1526# _old_run_process() is designed to be backgrounded by old_run_process() to simulate a
1527# fork. It includes the dirty work of closing extra filehandles and preparing log
1528# files to produce the same logs as screen_it(). The log filename is derived
1529# from the service name and global-and-now-misnamed ``SCREEN_LOGDIR``
1530# Uses globals ``CURRENT_LOG_TIME``, ``SCREEN_LOGDIR``, ``SCREEN_NAME``, ``SERVICE_DIR``
1531# _old_run_process service "command-line"
1532function _old_run_process {
1533 local service=$1
1534 local command="$2"
1535
1536 # Undo logging redirections and close the extra descriptors
1537 exec 1>&3
1538 exec 2>&3
1539 exec 3>&-
1540 exec 6>&-
1541
1542 if [[ -n ${SCREEN_LOGDIR} ]]; then
Dean Troyerad5cc982014-12-10 16:35:32 -06001543 exec 1>&${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} 2>&1
1544 ln -sf ${SCREEN_LOGDIR}/screen-${1}.log.${CURRENT_LOG_TIME} ${SCREEN_LOGDIR}/screen-${1}.log
Dean Troyer3159a822014-08-27 14:13:58 -05001545
1546 # TODO(dtroyer): Hack to get stdout from the Python interpreter for the logs.
1547 export PYTHONUNBUFFERED=1
1548 fi
1549
1550 exec /bin/bash -c "$command"
1551 die "$service exec failure: $command"
1552}
1553
1554# old_run_process() launches a child process that closes all file descriptors and
1555# then exec's the passed in command. This is meant to duplicate the semantics
1556# of screen_it() without screen. PIDs are written to
1557# ``$SERVICE_DIR/$SCREEN_NAME/$service.pid`` by the spawned child process.
1558# old_run_process service "command-line"
1559function old_run_process {
1560 local service=$1
1561 local command="$2"
1562
1563 # Spawn the child process
1564 _old_run_process "$service" "$command" &
1565 echo $!
1566}
1567
1568# Compatibility for existing start_XXXX() functions
1569# Uses global ``USE_SCREEN``
1570# screen_it service "command-line"
1571function screen_it {
1572 if is_service_enabled $1; then
1573 # Append the service to the screen rc file
1574 screen_rc "$1" "$2"
1575
1576 if [[ "$USE_SCREEN" = "True" ]]; then
Adam Gandelman8543a0f2014-10-16 17:42:33 -07001577 screen_process "$1" "$2"
Dean Troyer3159a822014-08-27 14:13:58 -05001578 else
1579 # Spawn directly without screen
1580 old_run_process "$1" "$2" >$SERVICE_DIR/$SCREEN_NAME/$1.pid
1581 fi
1582 fi
1583}
1584
1585# Compatibility for existing stop_XXXX() functions
1586# Stop a service in screen
1587# If a PID is available use it, kill the whole process group via TERM
1588# If screen is being used kill the screen window; this will catch processes
1589# that did not leave a PID behind
1590# screen_stop service
1591function screen_stop {
1592 # Clean up the screen window
1593 stop_process $1
1594}
1595
1596
Sean Dague2c65e712014-12-18 09:44:56 -05001597# Plugin Functions
1598# =================
1599
1600DEVSTACK_PLUGINS=${DEVSTACK_PLUGINS:-""}
1601
1602# enable_plugin <name> <url> [branch]
1603#
1604# ``name`` is an arbitrary name - (aka: glusterfs, nova-docker, zaqar)
1605# ``url`` is a git url
1606# ``branch`` is a gitref. If it's not set, defaults to master
1607function enable_plugin {
1608 local name=$1
1609 local url=$2
1610 local branch=${3:-master}
1611 DEVSTACK_PLUGINS+=",$name"
1612 GITREPO[$name]=$url
1613 GITDIR[$name]=$DEST/$name
1614 GITBRANCH[$name]=$branch
1615}
1616
1617# fetch_plugins
1618#
1619# clones all plugins
1620function fetch_plugins {
1621 local plugins="${DEVSTACK_PLUGINS}"
1622 local plugin
1623
1624 # short circuit if nothing to do
1625 if [[ -z $plugins ]]; then
1626 return
1627 fi
1628
Dean Troyerdc97cb72015-03-28 08:20:50 -05001629 echo "Fetching DevStack plugins"
Sean Dague2c65e712014-12-18 09:44:56 -05001630 for plugin in ${plugins//,/ }; do
1631 git_clone_by_name $plugin
1632 done
1633}
1634
1635# load_plugin_settings
1636#
1637# Load settings from plugins in the order that they were registered
1638function load_plugin_settings {
1639 local plugins="${DEVSTACK_PLUGINS}"
1640 local plugin
1641
1642 # short circuit if nothing to do
1643 if [[ -z $plugins ]]; then
1644 return
1645 fi
1646
1647 echo "Loading plugin settings"
1648 for plugin in ${plugins//,/ }; do
1649 local dir=${GITDIR[$plugin]}
1650 # source any known settings
1651 if [[ -f $dir/devstack/settings ]]; then
1652 source $dir/devstack/settings
1653 fi
1654 done
1655}
1656
Sean Dague6e275e12015-03-26 05:54:28 -04001657# plugin_override_defaults
1658#
1659# Run an extremely early setting phase for plugins that allows default
1660# overriding of services.
1661function plugin_override_defaults {
1662 local plugins="${DEVSTACK_PLUGINS}"
1663 local plugin
1664
1665 # short circuit if nothing to do
1666 if [[ -z $plugins ]]; then
1667 return
1668 fi
1669
1670 echo "Overriding Configuration Defaults"
1671 for plugin in ${plugins//,/ }; do
1672 local dir=${GITDIR[$plugin]}
1673 # source any overrides
1674 if [[ -f $dir/devstack/override-defaults ]]; then
1675 # be really verbose that an override is happening, as it
1676 # may not be obvious if things fail later.
1677 echo "$plugin has overriden the following defaults"
1678 cat $dir/devstack/override-defaults
1679 source $dir/devstack/override-defaults
1680 fi
1681 done
1682}
1683
Sean Dague2c65e712014-12-18 09:44:56 -05001684# run_plugins
1685#
1686# Run the devstack/plugin.sh in all the plugin directories. These are
1687# run in registration order.
1688function run_plugins {
1689 local mode=$1
1690 local phase=$2
Bharat Kumar Kobagana441ff072015-01-08 12:26:26 +05301691
1692 local plugins="${DEVSTACK_PLUGINS}"
1693 local plugin
Sean Dague2c65e712014-12-18 09:44:56 -05001694 for plugin in ${plugins//,/ }; do
1695 local dir=${GITDIR[$plugin]}
1696 if [[ -f $dir/devstack/plugin.sh ]]; then
1697 source $dir/devstack/plugin.sh $mode $phase
1698 fi
1699 done
1700}
1701
1702function run_phase {
1703 local mode=$1
1704 local phase=$2
1705 if [[ -d $TOP_DIR/extras.d ]]; then
1706 for i in $TOP_DIR/extras.d/*.sh; do
1707 [[ -r $i ]] && source $i $mode $phase
Sean Dague1de9e332015-10-07 08:46:13 -04001708 # NOTE(sdague): generate a big warning about using
1709 # extras.d in an unsupported way which will let us track
1710 # unsupported usage in the gate.
1711 local exceptions="50-ironic.sh 60-ceph.sh 80-tempest.sh"
1712 local extra=$(basename $i)
1713 if [[ ! ( $exceptions =~ "$extra" ) ]]; then
1714 deprecated "extras.d support is being removed in Mitaka-1"
1715 deprecated "jobs for project $extra will break after that point"
1716 deprecated "please move project to a supported devstack plugin model"
1717 fi
Sean Dague2c65e712014-12-18 09:44:56 -05001718 done
1719 fi
1720 # the source phase corresponds to settings loading in plugins
1721 if [[ "$mode" == "source" ]]; then
1722 load_plugin_settings
Sean Dague6e275e12015-03-26 05:54:28 -04001723 elif [[ "$mode" == "override_defaults" ]]; then
1724 plugin_override_defaults
Sean Dague2c65e712014-12-18 09:44:56 -05001725 else
1726 run_plugins $mode $phase
1727 fi
1728}
1729
Dean Troyerdff49a22014-01-30 15:37:40 -06001730
1731# Service Functions
1732# =================
1733
1734# remove extra commas from the input string (i.e. ``ENABLED_SERVICES``)
1735# _cleanup_service_list service-list
Ian Wienandaee18c72014-02-21 15:35:08 +11001736function _cleanup_service_list {
Dean Troyerdff49a22014-01-30 15:37:40 -06001737 echo "$1" | sed -e '
1738 s/,,/,/g;
1739 s/^,//;
1740 s/,$//
1741 '
1742}
1743
1744# disable_all_services() removes all current services
1745# from ``ENABLED_SERVICES`` to reset the configuration
1746# before a minimal installation
1747# Uses global ``ENABLED_SERVICES``
1748# disable_all_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001749function disable_all_services {
Dean Troyerdff49a22014-01-30 15:37:40 -06001750 ENABLED_SERVICES=""
1751}
1752
1753# Remove all services starting with '-'. For example, to install all default
1754# services except rabbit (rabbit) set in ``localrc``:
1755# ENABLED_SERVICES+=",-rabbit"
1756# Uses global ``ENABLED_SERVICES``
1757# disable_negated_services
Ian Wienandaee18c72014-02-21 15:35:08 +11001758function disable_negated_services {
Ian Wienand2796a822015-04-15 08:59:04 +10001759 local to_remove=""
1760 local remaining=""
Dean Troyerdff49a22014-01-30 15:37:40 -06001761 local service
Ian Wienand2796a822015-04-15 08:59:04 +10001762
1763 # build up list of services that should be removed; i.e. they
1764 # begin with "-"
1765 for service in ${ENABLED_SERVICES//,/ }; do
Dean Troyerdff49a22014-01-30 15:37:40 -06001766 if [[ ${service} == -* ]]; then
Ian Wienand2796a822015-04-15 08:59:04 +10001767 to_remove+=",${service#-}"
1768 else
1769 remaining+=",${service}"
Dean Troyerdff49a22014-01-30 15:37:40 -06001770 fi
1771 done
Ian Wienand2796a822015-04-15 08:59:04 +10001772
1773 # go through the service list. if this service appears in the "to
1774 # be removed" list, drop it
fumihiko kakuma8606c982015-04-13 09:55:06 +09001775 ENABLED_SERVICES=$(remove_disabled_services "$remaining" "$to_remove")
Dean Troyerdff49a22014-01-30 15:37:40 -06001776}
1777
1778# disable_service() removes the services passed as argument to the
1779# ``ENABLED_SERVICES`` list, if they are present.
1780#
1781# For example:
1782# disable_service rabbit
1783#
1784# This function does not know about the special cases
1785# for nova, glance, and neutron built into is_service_enabled().
1786# Uses global ``ENABLED_SERVICES``
1787# disable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001788function disable_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06001789 local tmpsvcs=",${ENABLED_SERVICES},"
1790 local service
1791 for service in $@; do
1792 if is_service_enabled $service; then
1793 tmpsvcs=${tmpsvcs//,$service,/,}
1794 fi
1795 done
1796 ENABLED_SERVICES=$(_cleanup_service_list "$tmpsvcs")
1797}
1798
1799# enable_service() adds the services passed as argument to the
1800# ``ENABLED_SERVICES`` list, if they are not already present.
1801#
1802# For example:
Sean Dague37eca482015-06-16 07:19:22 -04001803# enable_service q-svc
Dean Troyerdff49a22014-01-30 15:37:40 -06001804#
1805# This function does not know about the special cases
1806# for nova, glance, and neutron built into is_service_enabled().
1807# Uses global ``ENABLED_SERVICES``
1808# enable_service service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001809function enable_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06001810 local tmpsvcs="${ENABLED_SERVICES}"
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001811 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06001812 for service in $@; do
1813 if ! is_service_enabled $service; then
1814 tmpsvcs+=",$service"
1815 fi
1816 done
1817 ENABLED_SERVICES=$(_cleanup_service_list "$tmpsvcs")
1818 disable_negated_services
1819}
1820
1821# is_service_enabled() checks if the service(s) specified as arguments are
1822# enabled by the user in ``ENABLED_SERVICES``.
1823#
1824# Multiple services specified as arguments are ``OR``'ed together; the test
1825# is a short-circuit boolean, i.e it returns on the first match.
1826#
1827# There are special cases for some 'catch-all' services::
1828# **nova** returns true if any service enabled start with **n-**
1829# **cinder** returns true if any service enabled start with **c-**
Dean Troyerdff49a22014-01-30 15:37:40 -06001830# **glance** returns true if any service enabled start with **g-**
1831# **neutron** returns true if any service enabled start with **q-**
1832# **swift** returns true if any service enabled start with **s-**
1833# **trove** returns true if any service enabled start with **tr-**
1834# For backward compatibility if we have **swift** in ENABLED_SERVICES all the
1835# **s-** services will be enabled. This will be deprecated in the future.
1836#
1837# Cells within nova is enabled if **n-cell** is in ``ENABLED_SERVICES``.
1838# We also need to make sure to treat **n-cell-region** and **n-cell-child**
1839# as enabled in this case.
1840#
1841# Uses global ``ENABLED_SERVICES``
1842# is_service_enabled service [service ...]
Ian Wienandaee18c72014-02-21 15:35:08 +11001843function is_service_enabled {
Sean Dague45917cc2014-02-24 16:09:14 -05001844 local xtrace=$(set +o | grep xtrace)
1845 set +o xtrace
1846 local enabled=1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001847 local services=$@
1848 local service
Dean Troyerdff49a22014-01-30 15:37:40 -06001849 for service in ${services}; do
Sean Dague45917cc2014-02-24 16:09:14 -05001850 [[ ,${ENABLED_SERVICES}, =~ ,${service}, ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001851
1852 # Look for top-level 'enabled' function for this service
1853 if type is_${service}_enabled >/dev/null 2>&1; then
1854 # A function exists for this service, use it
Christian Schwede3db0aad2015-09-10 11:15:39 +00001855 is_${service}_enabled && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001856 fi
1857
1858 # TODO(dtroyer): Remove these legacy special-cases after the is_XXX_enabled()
1859 # are implemented
1860
Sean Dague45917cc2014-02-24 16:09:14 -05001861 [[ ${service} == n-cell-* && ${ENABLED_SERVICES} =~ "n-cell" ]] && enabled=0
Chris Dent2f27a0e2014-09-09 13:46:02 +01001862 [[ ${service} == n-cpu-* && ${ENABLED_SERVICES} =~ "n-cpu" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05001863 [[ ${service} == "nova" && ${ENABLED_SERVICES} =~ "n-" ]] && enabled=0
Sean Dague45917cc2014-02-24 16:09:14 -05001864 [[ ${service} == "glance" && ${ENABLED_SERVICES} =~ "g-" ]] && enabled=0
1865 [[ ${service} == "ironic" && ${ENABLED_SERVICES} =~ "ir-" ]] && enabled=0
1866 [[ ${service} == "neutron" && ${ENABLED_SERVICES} =~ "q-" ]] && enabled=0
1867 [[ ${service} == "trove" && ${ENABLED_SERVICES} =~ "tr-" ]] && enabled=0
1868 [[ ${service} == "swift" && ${ENABLED_SERVICES} =~ "s-" ]] && enabled=0
1869 [[ ${service} == s-* && ${ENABLED_SERVICES} =~ "swift" ]] && enabled=0
Dean Troyerdff49a22014-01-30 15:37:40 -06001870 done
Sean Dague45917cc2014-02-24 16:09:14 -05001871 $xtrace
1872 return $enabled
Dean Troyerdff49a22014-01-30 15:37:40 -06001873}
1874
fumihiko kakuma8606c982015-04-13 09:55:06 +09001875# remove specified list from the input string
1876# remove_disabled_services service-list remove-list
1877function remove_disabled_services {
1878 local service_list=$1
1879 local remove_list=$2
1880 local service
1881 local enabled=""
1882
1883 for service in ${service_list//,/ }; do
1884 local remove
1885 local add=1
1886 for remove in ${remove_list//,/ }; do
1887 if [[ ${remove} == ${service} ]]; then
1888 add=0
1889 break
1890 fi
1891 done
1892 if [[ $add == 1 ]]; then
1893 enabled="${enabled},$service"
1894 fi
1895 done
1896 _cleanup_service_list "$enabled"
1897}
1898
Dean Troyerdff49a22014-01-30 15:37:40 -06001899# Toggle enable/disable_service for services that must run exclusive of each other
1900# $1 The name of a variable containing a space-separated list of services
1901# $2 The name of a variable in which to store the enabled service's name
1902# $3 The name of the service to enable
1903function use_exclusive_service {
1904 local options=${!1}
1905 local selection=$3
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001906 local out=$2
Dean Troyerdff49a22014-01-30 15:37:40 -06001907 [ -z $selection ] || [[ ! "$options" =~ "$selection" ]] && return 1
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001908 local opt
Dean Troyerdff49a22014-01-30 15:37:40 -06001909 for opt in $options;do
1910 [[ "$opt" = "$selection" ]] && enable_service $opt || disable_service $opt
1911 done
1912 eval "$out=$selection"
1913 return 0
1914}
1915
1916
Masayuki Igawaf6368d32014-02-20 13:31:26 +09001917# System Functions
1918# ================
Dean Troyerdff49a22014-01-30 15:37:40 -06001919
1920# Only run the command if the target file (the last arg) is not on an
1921# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11001922function _safe_permission_operation {
Sean Dague45917cc2014-02-24 16:09:14 -05001923 local xtrace=$(set +o | grep xtrace)
1924 set +o xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001925 local args=( $@ )
1926 local last
1927 local sudo_cmd
1928 local dir_to_check
1929
1930 let last="${#args[*]} - 1"
1931
Dean Troyerd5dfa4c2014-07-25 11:13:11 -05001932 local dir_to_check=${args[$last]}
Dean Troyerdff49a22014-01-30 15:37:40 -06001933 if [ ! -d "$dir_to_check" ]; then
1934 dir_to_check=`dirname "$dir_to_check"`
1935 fi
1936
1937 if is_nfs_directory "$dir_to_check" ; then
Sean Dague45917cc2014-02-24 16:09:14 -05001938 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001939 return 0
1940 fi
1941
1942 if [[ $TRACK_DEPENDS = True ]]; then
1943 sudo_cmd="env"
1944 else
1945 sudo_cmd="sudo"
1946 fi
1947
Sean Dague45917cc2014-02-24 16:09:14 -05001948 $xtrace
Dean Troyerdff49a22014-01-30 15:37:40 -06001949 $sudo_cmd $@
1950}
1951
1952# Exit 0 if address is in network or 1 if address is not in network
1953# ip-range is in CIDR notation: 1.2.3.4/20
1954# address_in_net ip-address ip-range
Ian Wienandaee18c72014-02-21 15:35:08 +11001955function address_in_net {
Dean Troyerdff49a22014-01-30 15:37:40 -06001956 local ip=$1
1957 local range=$2
1958 local masklen=${range#*/}
1959 local network=$(maskip ${range%/*} $(cidr2netmask $masklen))
1960 local subnet=$(maskip $ip $(cidr2netmask $masklen))
1961 [[ $network == $subnet ]]
1962}
1963
1964# Add a user to a group.
1965# add_user_to_group user group
Ian Wienandaee18c72014-02-21 15:35:08 +11001966function add_user_to_group {
Dean Troyerdff49a22014-01-30 15:37:40 -06001967 local user=$1
1968 local group=$2
1969
Thomas Bechtolda8580852015-05-31 00:04:33 +02001970 sudo usermod -a -G "$group" "$user"
Dean Troyerdff49a22014-01-30 15:37:40 -06001971}
1972
1973# Convert CIDR notation to a IPv4 netmask
1974# cidr2netmask cidr-bits
Ian Wienandaee18c72014-02-21 15:35:08 +11001975function cidr2netmask {
Dean Troyerdff49a22014-01-30 15:37:40 -06001976 local maskpat="255 255 255 255"
1977 local maskdgt="254 252 248 240 224 192 128"
1978 set -- ${maskpat:0:$(( ($1 / 8) * 4 ))}${maskdgt:$(( (7 - ($1 % 8)) * 4 )):3}
1979 echo ${1-0}.${2-0}.${3-0}.${4-0}
1980}
1981
1982# Gracefully cp only if source file/dir exists
1983# cp_it source destination
1984function cp_it {
1985 if [ -e $1 ] || [ -d $1 ]; then
1986 cp -pRL $1 $2
1987 fi
1988}
1989
1990# HTTP and HTTPS proxy servers are supported via the usual environment variables [1]
1991# ``http_proxy``, ``https_proxy`` and ``no_proxy``. They can be set in
1992# ``localrc`` or on the command line if necessary::
1993#
1994# [1] http://www.w3.org/Daemon/User/Proxies/ProxyClients.html
1995#
1996# http_proxy=http://proxy.example.com:3128/ no_proxy=repo.example.net ./stack.sh
1997
Ian Wienandaee18c72014-02-21 15:35:08 +11001998function export_proxy_variables {
Sean Dague53753292014-12-04 19:38:15 -05001999 if isset http_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002000 export http_proxy=$http_proxy
2001 fi
Sean Dague53753292014-12-04 19:38:15 -05002002 if isset https_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002003 export https_proxy=$https_proxy
2004 fi
Sean Dague53753292014-12-04 19:38:15 -05002005 if isset no_proxy ; then
Dean Troyerdff49a22014-01-30 15:37:40 -06002006 export no_proxy=$no_proxy
2007 fi
2008}
2009
2010# Returns true if the directory is on a filesystem mounted via NFS.
Ian Wienandaee18c72014-02-21 15:35:08 +11002011function is_nfs_directory {
Dean Troyerdff49a22014-01-30 15:37:40 -06002012 local mount_type=`stat -f -L -c %T $1`
2013 test "$mount_type" == "nfs"
2014}
2015
2016# Return the network portion of the given IP address using netmask
2017# netmask is in the traditional dotted-quad format
2018# maskip ip-address netmask
Ian Wienandaee18c72014-02-21 15:35:08 +11002019function maskip {
Dean Troyerdff49a22014-01-30 15:37:40 -06002020 local ip=$1
2021 local mask=$2
2022 local l="${ip%.*}"; local r="${ip#*.}"; local n="${mask%.*}"; local m="${mask#*.}"
2023 local subnet=$((${ip%%.*}&${mask%%.*})).$((${r%%.*}&${m%%.*})).$((${l##*.}&${n##*.})).$((${ip##*.}&${mask##*.}))
2024 echo $subnet
2025}
2026
Chris Dent3a2c86a2015-05-12 13:41:25 +00002027# Return the current python as "python<major>.<minor>"
2028function python_version {
2029 local python_version=$(python -c 'import sys; print("%s.%s" % sys.version_info[0:2])')
2030 echo "python${python_version}"
2031}
2032
Dean Troyerdff49a22014-01-30 15:37:40 -06002033# Service wrapper to restart services
2034# restart_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002035function restart_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002036 if is_ubuntu; then
2037 sudo /usr/sbin/service $1 restart
2038 else
2039 sudo /sbin/service $1 restart
2040 fi
2041}
2042
2043# Only change permissions of a file or directory if it is not on an
2044# NFS filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002045function safe_chmod {
Dean Troyerdff49a22014-01-30 15:37:40 -06002046 _safe_permission_operation chmod $@
2047}
2048
2049# Only change ownership of a file or directory if it is not on an NFS
2050# filesystem.
Ian Wienandaee18c72014-02-21 15:35:08 +11002051function safe_chown {
Dean Troyerdff49a22014-01-30 15:37:40 -06002052 _safe_permission_operation chown $@
2053}
2054
2055# Service wrapper to start services
2056# start_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002057function start_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002058 if is_ubuntu; then
2059 sudo /usr/sbin/service $1 start
2060 else
2061 sudo /sbin/service $1 start
2062 fi
2063}
2064
2065# Service wrapper to stop services
2066# stop_service service-name
Ian Wienandaee18c72014-02-21 15:35:08 +11002067function stop_service {
Dean Troyerdff49a22014-01-30 15:37:40 -06002068 if is_ubuntu; then
2069 sudo /usr/sbin/service $1 stop
2070 else
2071 sudo /sbin/service $1 stop
2072 fi
2073}
2074
Sean Dague442e4e92015-06-24 13:24:02 -04002075# Test with a finite retry loop.
2076#
2077function test_with_retry {
2078 local testcmd=$1
2079 local failmsg=$2
2080 local until=${3:-10}
2081 local sleep=${4:-0.5}
2082
2083 if ! timeout $until sh -c "while ! $testcmd; do sleep $sleep; done"; then
2084 die $LINENO "$failmsg"
2085 fi
2086}
2087
Dean Troyerdff49a22014-01-30 15:37:40 -06002088
2089# Restore xtrace
2090$XTRACE
2091
2092# Local variables:
2093# mode: shell-script
2094# End: