Skip to content

Commit 6563a3c

Browse files
Dean Troyervishvananda
Dean Troyer
authored and
vishvananda
committed
Extract common functions into a separate file
This is the start of an effort to organize devstack's code to better document the requirements for configuring the individual components. Change-Id: I3476b76b9d1f9ee63687fb9898a98729118cbd84
1 parent 84c0599 commit 6563a3c

File tree

9 files changed

+125
-181
lines changed

9 files changed

+125
-181
lines changed

‎functions‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# functions - Common functions used by DevStack components
2+
3+
4+
# apt-get wrapper to set arguments correctly
5+
# apt_get package [package ...]
6+
function apt_get() {
7+
[[ "$OFFLINE" = "True" ]] && return
8+
local sudo="sudo"
9+
[[ "$(id -u)" = "0" ]] && sudo="env"
10+
$sudo DEBIAN_FRONTEND=noninteractive \
11+
http_proxy=$http_proxy https_proxy=$https_proxy \
12+
apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@"
13+
}
14+
15+
16+
# Gracefully cp only if source file/dir exists
17+
# cp_it source destination
18+
function cp_it {
19+
if [ -e $1 ] || [ -d $1 ]; then
20+
cp -pRL $1 $2
21+
fi
22+
}
23+
24+
25+
# git clone only if directory doesn't exist already. Since ``DEST`` might not
26+
# be owned by the installation user, we create the directory and change the
27+
# ownership to the proper user.
28+
# Set global RECLONE=yes to simulate a clone when dest-dir exists
29+
# git_clone remote dest-dir branch
30+
function git_clone {
31+
[[ "$OFFLINE" = "True" ]] && return
32+
33+
GIT_REMOTE=$1
34+
GIT_DEST=$2
35+
GIT_BRANCH=$3
36+
37+
if echo $GIT_BRANCH | egrep -q "^refs"; then
38+
# If our branch name is a gerrit style refs/changes/...
39+
if [[ ! -d $GIT_DEST ]]; then
40+
git clone $GIT_REMOTE $GIT_DEST
41+
fi
42+
cd $GIT_DEST
43+
git fetch $GIT_REMOTE $GIT_BRANCH && git checkout FETCH_HEAD
44+
else
45+
# do a full clone only if the directory doesn't exist
46+
if [[ ! -d $GIT_DEST ]]; then
47+
git clone $GIT_REMOTE $GIT_DEST
48+
cd $GIT_DEST
49+
# This checkout syntax works for both branches and tags
50+
git checkout $GIT_BRANCH
51+
elif [[ "$RECLONE" == "yes" ]]; then
52+
# if it does exist then simulate what clone does if asked to RECLONE
53+
cd $GIT_DEST
54+
# set the url to pull from and fetch
55+
git remote set-url origin $GIT_REMOTE
56+
git fetch origin
57+
# remove the existing ignored files (like pyc) as they cause breakage
58+
# (due to the py files having older timestamps than our pyc, so python
59+
# thinks the pyc files are correct using them)
60+
find $GIT_DEST -name '*.pyc' -delete
61+
git checkout -f origin/$GIT_BRANCH
62+
# a local branch might not exist
63+
git branch -D $GIT_BRANCH || true
64+
git checkout -b $GIT_BRANCH
65+
fi
66+
fi
67+
}
68+
69+
70+
# pip install wrapper to set cache and proxy environment variables
71+
# pip_install package [package ...]
72+
function pip_install {
73+
[[ "$OFFLINE" = "True" ]] && return
74+
sudo PIP_DOWNLOAD_CACHE=/var/cache/pip \
75+
HTTP_PROXY=$http_proxy \
76+
HTTPS_PROXY=$https_proxy \
77+
pip install --use-mirrors $@
78+
}
79+
80+
81+
# Normalize config values to True or False
82+
# VAR=`trueorfalse default-value test-value`
83+
function trueorfalse() {
84+
local default=$1
85+
local testval=$2
86+
87+
[[ -z "$testval" ]] && { echo "$default"; return; }
88+
[[ "0 no false False FALSE" =~ "$testval" ]] && { echo "False"; return; }
89+
[[ "1 yes true True TRUE" =~ "$testval" ]] && { echo "True"; return; }
90+
echo "$default"
91+
}

‎stack.sh‎

Lines changed: 3 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ fi
3535
# Keep track of the current devstack directory.
3636
TOP_DIR=$(cd $(dirname "$0") && pwd)
3737

38+
# Import common functions
39+
. $TOP_DIR/functions
40+
3841
# stack.sh keeps the list of **apt** and **pip** dependencies in external
3942
# files, along with config templates and other useful files. You can find these
4043
# in the ``files`` directory (next to this script). We will reference this
@@ -86,16 +89,6 @@ source ./stackrc
8689
# Destination path for installation ``DEST``
8790
DEST=${DEST:-/opt/stack}
8891

89-
# apt-get wrapper to just get arguments set correctly
90-
function apt_get() {
91-
[[ "$OFFLINE" = "True" ]] && return
92-
local sudo="sudo"
93-
[ "$(id -u)" = "0" ] && sudo="env"
94-
$sudo DEBIAN_FRONTEND=noninteractive \
95-
http_proxy=$http_proxy https_proxy=$https_proxy \
96-
apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@"
97-
}
98-
9992
# Check to see if we are already running a stack.sh
10093
if screen -ls | egrep -q "[0-9].stack"; then
10194
echo "You are already running a stack.sh session."
@@ -155,18 +148,6 @@ else
155148
sudo mv $TEMPFILE /etc/sudoers.d/stack_sh_nova
156149
fi
157150

158-
# Normalize config values to True or False
159-
# VAR=`trueorfalse default-value test-value`
160-
function trueorfalse() {
161-
local default=$1
162-
local testval=$2
163-
164-
[[ -z "$testval" ]] && { echo "$default"; return; }
165-
[[ "0 no false False FALSE" =~ "$testval" ]] && { echo "False"; return; }
166-
[[ "1 yes true True TRUE" =~ "$testval" ]] && { echo "True"; return; }
167-
echo "$default"
168-
}
169-
170151
# Set True to configure stack.sh to run cleanly without Internet access.
171152
# stack.sh must have been previously run with Internet access to install
172153
# prerequisites and initialize $DEST.
@@ -542,63 +523,13 @@ function get_packages() {
542523
done
543524
}
544525

545-
function pip_install {
546-
[[ "$OFFLINE" = "True" ]] && return
547-
sudo PIP_DOWNLOAD_CACHE=/var/cache/pip \
548-
HTTP_PROXY=$http_proxy \
549-
HTTPS_PROXY=$https_proxy \
550-
pip install --use-mirrors $@
551-
}
552-
553526
# install apt requirements
554527
apt_get update
555528
apt_get install $(get_packages)
556529

557530
# install python requirements
558531
pip_install `cat $FILES/pips/* | uniq`
559532

560-
# git clone only if directory doesn't exist already. Since ``DEST`` might not
561-
# be owned by the installation user, we create the directory and change the
562-
# ownership to the proper user.
563-
function git_clone {
564-
[[ "$OFFLINE" = "True" ]] && return
565-
566-
GIT_REMOTE=$1
567-
GIT_DEST=$2
568-
GIT_BRANCH=$3
569-
570-
if echo $GIT_BRANCH | egrep -q "^refs"; then
571-
# If our branch name is a gerrit style refs/changes/...
572-
if [ ! -d $GIT_DEST ]; then
573-
git clone $GIT_REMOTE $GIT_DEST
574-
fi
575-
cd $GIT_DEST
576-
git fetch $GIT_REMOTE $GIT_BRANCH && git checkout FETCH_HEAD
577-
else
578-
# do a full clone only if the directory doesn't exist
579-
if [ ! -d $GIT_DEST ]; then
580-
git clone $GIT_REMOTE $GIT_DEST
581-
cd $GIT_DEST
582-
# This checkout syntax works for both branches and tags
583-
git checkout $GIT_BRANCH
584-
elif [[ "$RECLONE" == "yes" ]]; then
585-
# if it does exist then simulate what clone does if asked to RECLONE
586-
cd $GIT_DEST
587-
# set the url to pull from and fetch
588-
git remote set-url origin $GIT_REMOTE
589-
git fetch origin
590-
# remove the existing ignored files (like pyc) as they cause breakage
591-
# (due to the py files having older timestamps than our pyc, so python
592-
# thinks the pyc files are correct using them)
593-
find $GIT_DEST -name '*.pyc' -delete
594-
git checkout -f origin/$GIT_BRANCH
595-
# a local branch might not exist
596-
git branch -D $GIT_BRANCH || true
597-
git checkout -b $GIT_BRANCH
598-
fi
599-
fi
600-
}
601-
602533
# compute service
603534
git_clone $NOVA_REPO $NOVA_DIR $NOVA_BRANCH
604535
# python client library to nova that horizon (and others) use

‎tools/build_ramdisk.sh‎

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ IMG_FILE=$1
4747

4848
# Keep track of the current directory
4949
TOOLS_DIR=$(cd $(dirname "$0") && pwd)
50-
TOP_DIR=`cd $TOOLS_DIR/..; pwd`
50+
TOP_DIR=$(cd $TOOLS_DIR/..; pwd)
51+
52+
# Import common functions
53+
. $TOP_DIR/functions
5154

5255
# Store cwd
5356
CWD=`pwd`
@@ -170,35 +173,6 @@ if [ ! -r "`ls $MNTDIR/boot/vmlinuz-*-generic | head -1`" ]; then
170173
chroot $MNTDIR apt-get install -y linux-generic
171174
fi
172175

173-
# git clone only if directory doesn't exist already. Since ``DEST`` might not
174-
# be owned by the installation user, we create the directory and change the
175-
# ownership to the proper user.
176-
function git_clone {
177-
178-
# clone new copy or fetch latest changes
179-
CHECKOUT=${MNTDIR}$2
180-
if [ ! -d $CHECKOUT ]; then
181-
mkdir -p $CHECKOUT
182-
git clone $1 $CHECKOUT
183-
else
184-
pushd $CHECKOUT
185-
git fetch
186-
popd
187-
fi
188-
189-
# FIXME(ja): checkout specified version (should works for branches and tags)
190-
191-
pushd $CHECKOUT
192-
# checkout the proper branch/tag
193-
git checkout $3
194-
# force our local version to be the same as the remote version
195-
git reset --hard origin/$3
196-
popd
197-
198-
# give ownership to the stack user
199-
chroot $MNTDIR chown -R stack $2
200-
}
201-
202176
git_clone $NOVA_REPO $DEST/nova $NOVA_BRANCH
203177
git_clone $GLANCE_REPO $DEST/glance $GLANCE_BRANCH
204178
git_clone $KEYSTONE_REPO $DEST/keystone $KEYSTONE_BRANCH

‎tools/build_tempest.sh‎

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ trap cleanup SIGHUP SIGINT SIGTERM SIGQUIT EXIT
2626

2727
# Keep track of the current directory
2828
TOOLS_DIR=$(cd $(dirname "$0") && pwd)
29-
TOP_DIR=`cd $TOOLS_DIR/..; pwd`
29+
TOP_DIR=$(cd $TOOLS_DIR/..; pwd)
30+
31+
# Import common functions
32+
. $TOP_DIR/functions
3033

3134
# Abort if localrc is not set
3235
if [ ! -e $TOP_DIR/localrc ]; then
@@ -43,42 +46,8 @@ DEST=${DEST:-/opt/stack}
4346

4447
TEMPEST_DIR=$DEST/tempest
4548

46-
DIST_NAME=${DIST_NAME:-oneiric}
47-
48-
# git clone only if directory doesn't exist already. Since ``DEST`` might not
49-
# be owned by the installation user, we create the directory and change the
50-
# ownership to the proper user.
51-
function git_clone {
52-
53-
GIT_REMOTE=$1
54-
GIT_DEST=$2
55-
GIT_BRANCH=$3
56-
57-
# do a full clone only if the directory doesn't exist
58-
if [ ! -d $GIT_DEST ]; then
59-
git clone $GIT_REMOTE $GIT_DEST
60-
cd $2
61-
# This checkout syntax works for both branches and tags
62-
git checkout $GIT_BRANCH
63-
elif [[ "$RECLONE" == "yes" ]]; then
64-
# if it does exist then simulate what clone does if asked to RECLONE
65-
cd $GIT_DEST
66-
# set the url to pull from and fetch
67-
git remote set-url origin $GIT_REMOTE
68-
git fetch origin
69-
# remove the existing ignored files (like pyc) as they cause breakage
70-
# (due to the py files having older timestamps than our pyc, so python
71-
# thinks the pyc files are correct using them)
72-
find $GIT_DEST -name '*.pyc' -delete
73-
git checkout -f origin/$GIT_BRANCH
74-
# a local branch might not exist
75-
git branch -D $GIT_BRANCH || true
76-
git checkout -b $GIT_BRANCH
77-
fi
78-
}
79-
8049
# Install tests and prerequisites
81-
sudo PIP_DOWNLOAD_CACHE=/var/cache/pip pip install --use-mirrors `cat $TOP_DIR/files/pips/tempest`
50+
pip_install `cat $TOP_DIR/files/pips/tempest`
8251

8352
git_clone $TEMPEST_REPO $TEMPEST_DIR $TEMPEST_BRANCH
8453

‎tools/build_uec.sh‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ fi
88

99
# Keep track of the current directory
1010
TOOLS_DIR=$(cd $(dirname "$0") && pwd)
11-
TOP_DIR=`cd $TOOLS_DIR/..; pwd`
11+
TOP_DIR=$(cd $TOOLS_DIR/..; pwd)
12+
13+
# Import common functions
14+
. $TOP_DIR/functions
1215

1316
cd $TOP_DIR
1417

@@ -34,7 +37,7 @@ fi
3437

3538
# Install deps if needed
3639
DEPS="kvm libvirt-bin kpartx cloud-utils curl"
37-
apt-get install -y --force-yes $DEPS || true # allow this to fail gracefully for concurrent builds
40+
apt_get install -y --force-yes $DEPS || true # allow this to fail gracefully for concurrent builds
3841

3942
# Where to store files and instances
4043
WORK_DIR=${WORK_DIR:-/opt/uecstack}

‎tools/build_uec_ramdisk.sh‎

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ DEST_FILE=$1
4040

4141
# Keep track of the current directory
4242
TOOLS_DIR=$(cd $(dirname "$0") && pwd)
43-
TOP_DIR=`cd $TOOLS_DIR/..; pwd`
43+
TOP_DIR=$(cd $TOOLS_DIR/..; pwd)
44+
45+
# Import common functions
46+
. $TOP_DIR/functions
4447

4548
cd $TOP_DIR
4649

@@ -68,7 +71,7 @@ fi
6871

6972
# Install deps if needed
7073
DEPS="kvm libvirt-bin kpartx cloud-utils curl"
71-
apt-get install -y --force-yes $DEPS
74+
apt_get install -y --force-yes $DEPS
7275

7376
# Where to store files and instances
7477
CACHEDIR=${CACHEDIR:-/opt/stack/cache}
@@ -113,35 +116,6 @@ if [ ! -r "`ls $MNT_DIR/boot/vmlinuz-*-generic | head -1`" ]; then
113116
chroot $MNT_DIR apt-get install -y linux-generic
114117
fi
115118

116-
# git clone only if directory doesn't exist already. Since ``DEST`` might not
117-
# be owned by the installation user, we create the directory and change the
118-
# ownership to the proper user.
119-
function git_clone {
120-
121-
# clone new copy or fetch latest changes
122-
CHECKOUT=${MNT_DIR}$2
123-
if [ ! -d $CHECKOUT ]; then
124-
mkdir -p $CHECKOUT
125-
git clone $1 $CHECKOUT
126-
else
127-
pushd $CHECKOUT
128-
git fetch
129-
popd
130-
fi
131-
132-
# FIXME(ja): checkout specified version (should works for branches and tags)
133-
134-
pushd $CHECKOUT
135-
# checkout the proper branch/tag
136-
git checkout $3
137-
# force our local version to be the same as the remote version
138-
git reset --hard origin/$3
139-
popd
140-
141-
# give ownership to the stack user
142-
chroot $MNT_DIR chown -R stack $2
143-
}
144-
145119
git_clone $NOVA_REPO $DEST/nova $NOVA_BRANCH
146120
git_clone $GLANCE_REPO $DEST/glance $GLANCE_BRANCH
147121
git_clone $KEYSTONE_REPO $DEST/keystone $KEYSTONE_BRANCH

‎tools/configure_tempest.sh‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ trap cleanup SIGHUP SIGINT SIGTERM SIGQUIT EXIT
3030

3131
# Keep track of the current directory
3232
TOOLS_DIR=$(cd $(dirname "$0") && pwd)
33-
TOP_DIR=`cd $TOOLS_DIR/..; pwd`
33+
TOP_DIR=$(cd $TOOLS_DIR/..; pwd)
34+
35+
# Import common functions
36+
. $TOP_DIR/functions
3437

3538
# Abort if localrc is not set
3639
if [ ! -e $TOP_DIR/localrc ]; then

0 commit comments

Comments
 (0)