blob: 3a3c3c6f89d6fa98579c99dede44c06564293277 [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 Vachuska493175b2017-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
67alias deprecatedAlias='echo "This alias has been deprecated."'
68alias obi=deprecatedAlias
69alias obs=deprecatedAlias
70
Aaron Kruglikovc9390372017-06-16 13:20:42 -070071alias ok='NO_BUCKD=1 onos-buck run onos-local --'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070072alias oh='onos localhost halt'
73
tom0511a522014-10-04 12:06:02 -070074alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070075alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070076alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080077alias oi='setPrimaryInstance'
tom6a9f2722014-09-13 17:00:02 -070078
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070079# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070080alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070081alias gl='grep $KARAF_LOG --colour=auto -E -e '
82
Charles M.C. Chan870cc032015-04-24 04:57:42 +080083function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070084 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
85}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080086alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080087alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080088
89function filterLog {
90 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
91}
92alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070093alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070094
95# Pretty-print JSON output
96alias pp='python -m json.tool'
97
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070098# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070099alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -0700100alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -0700101alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -0700102
Thomas Vachuska6066dff2016-10-26 13:57:36 -0700103# Short-hand for 'mvn clean install' for us lazy folk
104alias mci='mvn clean install'
105alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
106alias mis='mvn install -DskipTests -Dcheckstyle.skip'
107
108# Git annotated one-line log
109alias gil='git log --oneline --decorate=short'
tom5c255702014-09-18 06:57:39 -0700110
tom5a18e802014-09-18 12:38:15 -0700111# Test related conveniences
112
tom5a18e802014-09-18 12:38:15 -0700113# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -0700114alias sshctl='onos-ssh'
115alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -0700116
Thomas Vachuskae1125352016-11-09 14:06:51 -0800117# Runs a sequence of STC scenarios until the first failure.
118function stcs {
Thomas Vachuska8cc53182016-11-14 13:06:54 -0800119 for s in "$@"; do
120 if [[ $s =~ ^[0-9]*$ ]]; then
121 printf "Waiting %d seconds...\n" $s
122 sleep $s
123 else
124 printf "Running scenario %s...\n" $s
125 stc $s || return 1
126 fi
127 done
Thomas Vachuskae1125352016-11-09 14:06:51 -0800128}
Thomas Vachuska785f5812015-03-19 01:11:00 -0700129
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700130# Applies the settings in the specified topology recipe file or lists current
131# topo recipe definition if no topo recipe file is given.
132function topo {
133 topo=${1:-""}
134 case "$topo" in
135 "")
136 env | egrep "ONOS_TOPO"
137 env | egrep "(OTD|OTL|OTH)="
138 ;;
139
140 *)
141 [ ! -f $ONOS_ROOT/tools/test/topos/$1.recipe ] && echo "No such topo recipe: $1" >&2 && return 1
142 unset ONOS_TOPO OTD OTL OTH ONOS_DEVICES ONOS_HOSTS
143 unset $(env | sed -n 's:\(^OT[DLH][0-9]\{1,\}\)=.*:\1 :g p')
144 export ONOS_TOPO=$1
145 . $ONOS_ROOT/tools/test/topos/$1.recipe
146 let d=1; while [ $d -le $OTD ]; do
147 dev="$(printf 'of:%016x' $d)"
148 export OTD$d=$dev; export ONOS_DEVICES="$ONOS_DEVICES $dev"
149 let d=d+1;
150 done
151 let h=1; while [ $h -le $OTH ]; do
152 host="$(printf '00:00:00:00:00:%02x/-1' $h)"
153 export OTH$h=$host; export ONOS_HOSTS="$ONOS_HOSTS $host"
154 let h=h+1
155 done
156 topo
157 esac
158}
159
160# Lists available topo recipes
161function topos {
162 for topo in $(ls -1 $ONOS_ROOT/tools/test/topos/*.recipe); do
163 name=$(basename $topo .recipe)
164 printf "%-16s %s\n" \
165 "$([ $name = $ONOS_TOPO ] && echo $name '*' || echo $name)" \
166 "$(grep '^#' $topo | head -n 1)"
167 done
168}
169
Thomas Vachuska785f5812015-03-19 01:11:00 -0700170# Sets the primary instance to the specified instance number.
171function setPrimaryInstance {
Jon Hallee85e2f2016-06-07 10:36:33 -0700172 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700173 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
174 echo $OCI
175}
176
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700177# ON.Lab shared test cell warden address
178export CELL_WARDEN="10.254.1.19"
Thomas Vachuskab0734592017-07-18 17:13:01 -0700179export CELL_SLAVES="$CELL_WARDEN 10.254.1.18 10.254.1.17"
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700180
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700181# Clears cell environment
182function clearCell {
183 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
184 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
Charles Chanc7a60ce2017-05-05 13:56:27 -0700185 unset ONOS_USER ONOS_GROUP ONOS_WEB_USER ONOS_WEB_PASS
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700186 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
187}
188
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700189# Applies the settings in the specified cell file or lists current cell definition
190# if no cell file is given.
191function cell {
Jon Hall7dc59d62016-05-10 14:30:16 -0700192 cell=${1:-""}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700193 case "$cell" in
194 "borrow")
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700195 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700196 aux="/tmp/cell-$$"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700197 duration=${2:-0}
Thomas Vachuska5420ba32016-05-13 14:45:25 -0400198 spec=${3:-3+1}
199 spec=${spec/+/%2B}
200 user=${4:-$(id -un)}
Thomas Vachuska05e47a32016-10-24 09:35:11 -0700201 hint=${5}
202 query="duration=$duration&spec=$spec&user=$user&cellNameHint=$hint"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700203 curl -sS -X POST "http://$CELL_WARDEN:4321/?$query" -d "$(cat ~/.ssh/id_rsa.pub)" > $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700204 . $aux
205 rm -f $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700206 setPrimaryInstance 1 >/dev/null
207 onos-verify-cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700208 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700209 ;;
210 "return")
211 curl -sS -X DELETE "http://$CELL_WARDEN:4321/?user=${2:-$(id -un)}"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700212 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700213 ;;
214
215 "status")
216 curl -sS "http://$CELL_WARDEN:4321/" | sort
217 ;;
218
219 "")
Charles Chan9b152fc2016-11-21 12:06:49 -0800220 env | egrep "^ONOS_CELL"
221 env | egrep "^OCI"
222 env | egrep "^OC[0-9]+" | sort
223 env | egrep "^OC[NT]"
224 env | egrep "^ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES|ONOS_DEVICES|ONOS_HOSTS' | sort
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700225 ;;
226
227 *)
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700228 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && echo "No such cell: $1" >&2 && return 1
229 clearCell
Charles Chanc7a60ce2017-05-05 13:56:27 -0700230 export ONOS_USER=sdn
231 export ONOS_GROUP=sdn
232 export ONOS_WEB_USER=onos
233 export ONOS_WEB_PASS=rocks
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700234 export ONOS_CELL=$1
235 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700236 setPrimaryInstance 1 >/dev/null
237 cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700238 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700239 esac
240}
tomecd0fbd2014-09-19 08:47:05 -0700241
Thomas Vachuskae6185572016-05-04 19:26:15 -0700242[ -n "$ONOS_CELL" -a "$ONOS_CELL" != "borrow" ] && cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700243
244# Lists available cells
245function cells {
tom2482e6f2014-10-01 16:51:48 -0700246 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700247 printf "%-16s %s\n" \
Yi Tseng7f425d52017-02-02 13:33:59 -0800248 "$([ ! -z $ONOS_CELL ] && [ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
tom2482e6f2014-10-01 16:51:48 -0700249 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
250 done
tomecd0fbd2014-09-19 08:47:05 -0700251}
tom5a18e802014-09-18 12:38:15 -0700252
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800253# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700254function spy {
255 ps -ef | egrep "$@" | grep -v egrep
256}
257
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800258# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700259function nuke {
tom85258ee2014-10-07 00:10:02 -0700260 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700261}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800262
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700263# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
264function vicell {
265 local apply=false
266 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800267 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700268 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800269
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800270 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700271 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800272 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700273 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800274 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700275 printf "\t-c: create cell file if none exist\n\n"
276 return 1
277 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800278
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700279 while [ $# -gt 0 ]; do
280 case "$1" in
281 -a) apply=true ;;
282 -e) EDITOR=$2; shift ;;
283 -c) create=true ;;
284 *) cdf="$1" ;;
285 esac
286 shift
287 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800288
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800289 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700290 printf "${cdf} : no such cell\n" && return 1
291 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800292
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700293 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
294 unset EDITOR && vi ${cpath}${cdf}
295 else
296 $EDITOR ${cpath}${cdf}
297 fi
298 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800299}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800300
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800301# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800302. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800303
304
305# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800306alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800307
308# Load UK topo GEO data
309alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'