blob: ab959055993bd3630afc8cabc795467c11864df4 [file] [log] [blame]
tom6a9f2722014-09-13 17:00:02 -07001#!/bin/bash
2# ONOS developer BASH profile conveniences
tom5a18e802014-09-18 12:38:15 -07003# Simply include in your own .bash_aliases or .bash_profile
tom6a9f2722014-09-13 17:00:02 -07004
5# Root of the ONOS source tree
Thomas Vachuska045c01d2014-12-04 00:18:06 -08006export ONOS_ROOT=${ONOS_ROOT:-~/onos}
Ray Milkey8a0c7c72017-07-18 11:37:04 -07007# This is a hack to remove symlinks from the ONOS_ROOT path. To be removed when
8# the protobuf buck rules can handle symlinks
9ONOS_ROOT=$(pushd $ONOS_ROOT >/dev/null && pwd -P && popd >/dev/null)
tom6a9f2722014-09-13 17:00:02 -070010
11# Setup some environmental context for developers
Pavlin Radoslavov93617212014-10-16 09:54:04 -070012if [ -z "${JAVA_HOME}" ]; then
13 if [ -x /usr/libexec/java_home ]; then
Thomas Vachuskad8531152014-11-03 14:39:57 -080014 export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
15 elif [ -d /usr/lib/jvm/java-8-oracle ]; then
16 export JAVA_HOME="/usr/lib/jvm/java-8-oracle"
Jonathan Harte3c951e2015-07-14 13:28:35 -070017 elif [ -d /usr/lib/jvm/java-8-openjdk-amd64 ]; then
18 export JAVA_HOME="/usr/lib/jvm/java-8-openjdk-amd64"
Pavlin Radoslavov93617212014-10-16 09:54:04 -070019 fi
20fi
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070021
Jian Li98dc9ad2016-01-06 14:05:47 -080022export MAVEN=${MAVEN:-~/Applications/apache-maven-3.3.9}
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070023
Jon Hallb84df5d2017-01-31 11:19:48 -080024export KARAF_VERSION=${KARAF_VERSION:-3.0.8}
Thomas Vachuska255b65f2014-11-23 14:25:31 -080025export KARAF_ROOT=${KARAF_ROOT:-~/Applications/apache-karaf-$KARAF_VERSION}
26export KARAF_LOG=$KARAF_ROOT/data/log/karaf.log
tom6a9f2722014-09-13 17:00:02 -070027
28# Setup a path
Thomas Vachuska4ccc7d32015-09-03 13:39:40 -070029export PATH="$PATH:$ONOS_ROOT/tools/dev/bin"
30export PATH="$PATH:$ONOS_ROOT/tools/test/bin:$ONOS_ROOT/tools/test/scenarios/bin"
Devin Lim0d944e22017-06-23 15:17:53 -070031export RUN_PACK_PATH=${RUN_PACK_PATH:-$ONOS_ROOT/tools/package/runtime/bin}
32export PATH="$RUN_PACK_PATH:$PATH"
tom1cd74ae2014-10-01 14:58:32 -070033export PATH="$PATH:$ONOS_ROOT/tools/build"
Thomas Vachuska255b65f2014-11-23 14:25:31 -080034export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin"
tom6a9f2722014-09-13 17:00:02 -070035
Roan Huang0fa4bc42015-05-01 15:38:20 +080036# Setup cell enviroment
37export ONOS_CELL=${ONOS_CELL:-local}
38
Thomas Vachuskac3c969a2015-08-19 16:51:16 -070039# Setup default web user/password
40export ONOS_WEB_USER=onos
41export ONOS_WEB_PASS=rocks
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070042
43# Setup default location of test scenarios
Thomas Vachuskae76f6532015-07-08 09:40:53 -070044export ONOS_SCENARIOS=$ONOS_ROOT/tools/test/scenarios
45
Carmelo Casconeb7524272017-06-05 16:53:13 -040046# Setup path to Mininet custom scripts
47export ONOS_MN_PY=$ONOS_ROOT/tools/dev/mininet/onos.py
48export BMV2_MN_PY=$ONOS_ROOT/tools/dev/mininet/bmv2.py
49
tom6a9f2722014-09-13 17:00:02 -070050# Convenience utility to warp to various ONOS source projects
51# e.g. 'o api', 'o dev', 'o'
52function o {
Ray Milkey33d81c62016-04-01 13:18:02 -070053 cd $(find $ONOS_ROOT/ -type d -and \( -name 'buck-out' -o -name '.git' -o -name 'target' -o -name 'gen-src' -o -name 'src' \) -prune -o -type d | \
Thomas Vachuska49367a62017-08-29 09:18:19 -070054 egrep "${1:-$ONOS_ROOT}" | awk '{print length($1)"\t"$1}' | sort -n | cut -f2 | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070055}
56
Thomas Vachuska6066dff2016-10-26 13:57:36 -070057# Buck (if "buck" is not on the PATH)
58[ -z "$(which buck)" ] && alias buck="onos-buck"
tom6a9f2722014-09-13 17:00:02 -070059
tom82d6bde2014-09-23 17:33:58 -070060# Short-hand for ONOS build, package and test.
61alias ob='onos-build'
Aaron Kruglikovc9390372017-06-16 13:20:42 -070062alias obf='(cd $ONOS_ROOT && onos-buck build onos)'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080063alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070064alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070065alias ot='onos-test'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070066
Yuta HIGUCHIa5ab2242018-02-14 14:10:54 -080067alias obr='while ! ob; do echo "retrying"; done'
68alias opr='while ! op; do echo "retrying"; done'
69
Thomas Vachuska6066dff2016-10-26 13:57:36 -070070alias deprecatedAlias='echo "This alias has been deprecated."'
71alias obi=deprecatedAlias
72alias obs=deprecatedAlias
73
Aaron Kruglikovc9390372017-06-16 13:20:42 -070074alias ok='NO_BUCKD=1 onos-buck run onos-local --'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070075alias oh='onos localhost halt'
76
tom0511a522014-10-04 12:06:02 -070077alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070078alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070079alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080080alias oi='setPrimaryInstance'
tom6a9f2722014-09-13 17:00:02 -070081
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070082# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070083alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070084alias gl='grep $KARAF_LOG --colour=auto -E -e '
85
Charles M.C. Chan870cc032015-04-24 04:57:42 +080086function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070087 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
88}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080089alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080090alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080091
92function filterLog {
93 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
94}
95alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070096alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070097
98# Pretty-print JSON output
99alias pp='python -m json.tool'
100
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -0700101# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -0700102alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -0700103alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -0700104alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -0700105
Thomas Vachuska6066dff2016-10-26 13:57:36 -0700106# Short-hand for 'mvn clean install' for us lazy folk
107alias mci='mvn clean install'
108alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
109alias mis='mvn install -DskipTests -Dcheckstyle.skip'
110
111# Git annotated one-line log
112alias gil='git log --oneline --decorate=short'
tom5c255702014-09-18 06:57:39 -0700113
tom5a18e802014-09-18 12:38:15 -0700114# Test related conveniences
115
tom5a18e802014-09-18 12:38:15 -0700116# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -0700117alias sshctl='onos-ssh'
118alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -0700119
Thomas Vachuskae1125352016-11-09 14:06:51 -0800120# Runs a sequence of STC scenarios until the first failure.
121function stcs {
Thomas Vachuska8cc53182016-11-14 13:06:54 -0800122 for s in "$@"; do
123 if [[ $s =~ ^[0-9]*$ ]]; then
124 printf "Waiting %d seconds...\n" $s
125 sleep $s
126 else
127 printf "Running scenario %s...\n" $s
128 stc $s || return 1
129 fi
130 done
Thomas Vachuskae1125352016-11-09 14:06:51 -0800131}
Thomas Vachuska785f5812015-03-19 01:11:00 -0700132
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700133# Applies the settings in the specified topology recipe file or lists current
134# topo recipe definition if no topo recipe file is given.
135function topo {
136 topo=${1:-""}
137 case "$topo" in
138 "")
139 env | egrep "ONOS_TOPO"
140 env | egrep "(OTD|OTL|OTH)="
141 ;;
142
143 *)
144 [ ! -f $ONOS_ROOT/tools/test/topos/$1.recipe ] && echo "No such topo recipe: $1" >&2 && return 1
145 unset ONOS_TOPO OTD OTL OTH ONOS_DEVICES ONOS_HOSTS
Ray Milkey2c6ffb82018-03-09 08:57:52 -0800146 ONOS_DEVICES=""
147 ONOS_HOSTS=""
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700148 unset $(env | sed -n 's:\(^OT[DLH][0-9]\{1,\}\)=.*:\1 :g p')
149 export ONOS_TOPO=$1
150 . $ONOS_ROOT/tools/test/topos/$1.recipe
151 let d=1; while [ $d -le $OTD ]; do
152 dev="$(printf 'of:%016x' $d)"
153 export OTD$d=$dev; export ONOS_DEVICES="$ONOS_DEVICES $dev"
154 let d=d+1;
155 done
156 let h=1; while [ $h -le $OTH ]; do
157 host="$(printf '00:00:00:00:00:%02x/-1' $h)"
158 export OTH$h=$host; export ONOS_HOSTS="$ONOS_HOSTS $host"
159 let h=h+1
160 done
161 topo
162 esac
163}
164
165# Lists available topo recipes
166function topos {
167 for topo in $(ls -1 $ONOS_ROOT/tools/test/topos/*.recipe); do
168 name=$(basename $topo .recipe)
169 printf "%-16s %s\n" \
170 "$([ $name = $ONOS_TOPO ] && echo $name '*' || echo $name)" \
171 "$(grep '^#' $topo | head -n 1)"
172 done
173}
174
Thomas Vachuska785f5812015-03-19 01:11:00 -0700175# Sets the primary instance to the specified instance number.
176function setPrimaryInstance {
Jon Hallee85e2f2016-06-07 10:36:33 -0700177 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700178 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
179 echo $OCI
180}
181
Jordan Halterman980a8c12017-09-22 18:01:19 -0700182# Sets minority (OCMI) and majority (OCMA) variables
183function setMinorityMajority {
184 nodes=($(env | grep 'OC[0-9]*=' | sort | cut -d= -f2))
185 middle=$(expr "${#nodes[@]}" / "2")
186 index=0
187 min=1
188 maj=1
189 for node in "${nodes[@]}"; do
190 if [ "$index" -gt "$middle" ]; then
191 export OCMI${min}=${node}
192 min=$(expr $min + 1)
193 else
194 export OCMA${maj}=${node}
195 maj=$(expr $maj + 1)
196 fi
197 index=$(expr $index + 1)
198 done
199}
200
Thomas Vachuskaa10137c2018-04-03 16:45:59 -0700201# Open Networking Foundation shared test cell warden address
Thomas Vachuska28d46572017-12-05 13:39:27 -0800202export CELL_WARDEN="10.192.19.72"
Thomas Vachuskaca40fe42018-01-29 16:13:26 -0800203export CELL_SLAVE_1=$CELL_WARDEN
204export CELL_SLAVE_2="10.192.19.71"
205export CELL_SLAVE_3="10.192.19.70"
206export CELL_SLAVE_4="10.192.19.77"
207export CELL_SLAVES="$CELL_SLAVE_1 $CELL_SLAVE_2 $CELL_SLAVE_3 $CELL_SLAVE_4"
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700208
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700209# Clears cell environment
210function clearCell {
211 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
212 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
Charles Chanc7a60ce2017-05-05 13:56:27 -0700213 unset ONOS_USER ONOS_GROUP ONOS_WEB_USER ONOS_WEB_PASS
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700214 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
Jordan Halterman980a8c12017-09-22 18:01:19 -0700215 unset $(env | sed -n 's:\(^OCMI[0-9]\{1,\}\)=.*:\1 :g p')
216 unset $(env | sed -n 's:\(^OCMA[0-9]\{1,\}\)=.*:\1 :g p')
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700217}
218
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700219# Applies the settings in the specified cell file or lists current cell definition
220# if no cell file is given.
221function cell {
Jon Hall7dc59d62016-05-10 14:30:16 -0700222 cell=${1:-""}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700223 case "$cell" in
224 "borrow")
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700225 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700226 aux="/tmp/cell-$$"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700227 duration=${2:-0}
Thomas Vachuska5420ba32016-05-13 14:45:25 -0400228 spec=${3:-3+1}
229 spec=${spec/+/%2B}
230 user=${4:-$(id -un)}
Ray Milkey32e73d72018-03-09 09:52:29 -0800231 hint=${5:-""}
Thomas Vachuska05e47a32016-10-24 09:35:11 -0700232 query="duration=$duration&spec=$spec&user=$user&cellNameHint=$hint"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700233 curl -sS -X POST "http://$CELL_WARDEN:4321/?$query" -d "$(cat ~/.ssh/id_rsa.pub)" > $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700234 . $aux
235 rm -f $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700236 setPrimaryInstance 1 >/dev/null
Jordan Halterman980a8c12017-09-22 18:01:19 -0700237 setMinorityMajority >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700238 onos-verify-cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700239 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700240 ;;
241 "return")
242 curl -sS -X DELETE "http://$CELL_WARDEN:4321/?user=${2:-$(id -un)}"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700243 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700244 ;;
245
246 "status")
247 curl -sS "http://$CELL_WARDEN:4321/" | sort
248 ;;
249
250 "")
Charles Chan9b152fc2016-11-21 12:06:49 -0800251 env | egrep "^ONOS_CELL"
252 env | egrep "^OCI"
253 env | egrep "^OC[0-9]+" | sort
254 env | egrep "^OC[NT]"
255 env | egrep "^ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES|ONOS_DEVICES|ONOS_HOSTS' | sort
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700256 ;;
257
258 *)
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700259 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && echo "No such cell: $1" >&2 && return 1
260 clearCell
Charles Chanc7a60ce2017-05-05 13:56:27 -0700261 export ONOS_USER=sdn
262 export ONOS_GROUP=sdn
263 export ONOS_WEB_USER=onos
264 export ONOS_WEB_PASS=rocks
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700265 export ONOS_CELL=$1
266 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700267 setPrimaryInstance 1 >/dev/null
268 cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700269 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700270 esac
271}
tomecd0fbd2014-09-19 08:47:05 -0700272
Thomas Vachuskae6185572016-05-04 19:26:15 -0700273[ -n "$ONOS_CELL" -a "$ONOS_CELL" != "borrow" ] && cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700274
275# Lists available cells
276function cells {
tom2482e6f2014-10-01 16:51:48 -0700277 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700278 printf "%-16s %s\n" \
Yi Tseng7f425d52017-02-02 13:33:59 -0800279 "$([ ! -z $ONOS_CELL ] && [ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
tom2482e6f2014-10-01 16:51:48 -0700280 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
281 done
tomecd0fbd2014-09-19 08:47:05 -0700282}
tom5a18e802014-09-18 12:38:15 -0700283
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800284# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700285function spy {
286 ps -ef | egrep "$@" | grep -v egrep
287}
288
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800289# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700290function nuke {
tom85258ee2014-10-07 00:10:02 -0700291 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700292}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800293
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700294# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
295function vicell {
296 local apply=false
297 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800298 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700299 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800300
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800301 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700302 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800303 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700304 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800305 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700306 printf "\t-c: create cell file if none exist\n\n"
307 return 1
308 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800309
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700310 while [ $# -gt 0 ]; do
311 case "$1" in
312 -a) apply=true ;;
313 -e) EDITOR=$2; shift ;;
314 -c) create=true ;;
315 *) cdf="$1" ;;
316 esac
317 shift
318 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800319
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800320 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700321 printf "${cdf} : no such cell\n" && return 1
322 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800323
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700324 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
325 unset EDITOR && vi ${cpath}${cdf}
326 else
327 $EDITOR ${cpath}${cdf}
328 fi
329 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800330}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800331
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800332# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800333. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800334
335
336# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800337alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800338
339# Load UK topo GEO data
340alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'