blob: afac5f681ec687eeed21132bd8d18b0ebe6c5bc7 [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}
tom6a9f2722014-09-13 17:00:02 -07007
8# Setup some environmental context for developers
Pavlin Radoslavov93617212014-10-16 09:54:04 -07009if [ -z "${JAVA_HOME}" ]; then
10 if [ -x /usr/libexec/java_home ]; then
Thomas Vachuskad8531152014-11-03 14:39:57 -080011 export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
12 elif [ -d /usr/lib/jvm/java-8-oracle ]; then
13 export JAVA_HOME="/usr/lib/jvm/java-8-oracle"
Jonathan Harte3c951e2015-07-14 13:28:35 -070014 elif [ -d /usr/lib/jvm/java-8-openjdk-amd64 ]; then
15 export JAVA_HOME="/usr/lib/jvm/java-8-openjdk-amd64"
Pavlin Radoslavov93617212014-10-16 09:54:04 -070016 fi
17fi
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070018
Jian Li98dc9ad2016-01-06 14:05:47 -080019export MAVEN=${MAVEN:-~/Applications/apache-maven-3.3.9}
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070020
Jon Hallb84df5d2017-01-31 11:19:48 -080021export KARAF_VERSION=${KARAF_VERSION:-3.0.8}
Thomas Vachuska255b65f2014-11-23 14:25:31 -080022export KARAF_ROOT=${KARAF_ROOT:-~/Applications/apache-karaf-$KARAF_VERSION}
23export KARAF_LOG=$KARAF_ROOT/data/log/karaf.log
tom6a9f2722014-09-13 17:00:02 -070024
25# Setup a path
Thomas Vachuska4ccc7d32015-09-03 13:39:40 -070026export PATH="$PATH:$ONOS_ROOT/tools/dev/bin"
27export PATH="$PATH:$ONOS_ROOT/tools/test/bin:$ONOS_ROOT/tools/test/scenarios/bin"
Devin Lim0d944e22017-06-23 15:17:53 -070028export RUN_PACK_PATH=${RUN_PACK_PATH:-$ONOS_ROOT/tools/package/runtime/bin}
29export PATH="$RUN_PACK_PATH:$PATH"
tom1cd74ae2014-10-01 14:58:32 -070030export PATH="$PATH:$ONOS_ROOT/tools/build"
Thomas Vachuska255b65f2014-11-23 14:25:31 -080031export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin"
tom6a9f2722014-09-13 17:00:02 -070032
Roan Huang0fa4bc42015-05-01 15:38:20 +080033# Setup cell enviroment
34export ONOS_CELL=${ONOS_CELL:-local}
35
Thomas Vachuskac3c969a2015-08-19 16:51:16 -070036# Setup default web user/password
37export ONOS_WEB_USER=onos
38export ONOS_WEB_PASS=rocks
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070039
40# Setup default location of test scenarios
Thomas Vachuskae76f6532015-07-08 09:40:53 -070041export ONOS_SCENARIOS=$ONOS_ROOT/tools/test/scenarios
42
Carmelo Casconeb7524272017-06-05 16:53:13 -040043# Setup path to Mininet custom scripts
44export ONOS_MN_PY=$ONOS_ROOT/tools/dev/mininet/onos.py
45export BMV2_MN_PY=$ONOS_ROOT/tools/dev/mininet/bmv2.py
46
tom6a9f2722014-09-13 17:00:02 -070047# Convenience utility to warp to various ONOS source projects
48# e.g. 'o api', 'o dev', 'o'
49function o {
Ray Milkey33d81c62016-04-01 13:18:02 -070050 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 | \
HIGUCHI Yuta709e4fe2016-03-12 21:29:41 -080051 egrep "${1:-$ONOS_ROOT}" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070052}
53
Thomas Vachuska6066dff2016-10-26 13:57:36 -070054# Buck (if "buck" is not on the PATH)
55[ -z "$(which buck)" ] && alias buck="onos-buck"
tom6a9f2722014-09-13 17:00:02 -070056
tom82d6bde2014-09-23 17:33:58 -070057# Short-hand for ONOS build, package and test.
58alias ob='onos-build'
Aaron Kruglikovc9390372017-06-16 13:20:42 -070059alias obf='(cd $ONOS_ROOT && onos-buck build onos)'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080060alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070061alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070062alias ot='onos-test'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070063
64alias deprecatedAlias='echo "This alias has been deprecated."'
65alias obi=deprecatedAlias
66alias obs=deprecatedAlias
67
Aaron Kruglikovc9390372017-06-16 13:20:42 -070068alias ok='NO_BUCKD=1 onos-buck run onos-local --'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070069alias oh='onos localhost halt'
70
tom0511a522014-10-04 12:06:02 -070071alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070072alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070073alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080074alias oi='setPrimaryInstance'
tom6a9f2722014-09-13 17:00:02 -070075
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070076# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070077alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070078alias gl='grep $KARAF_LOG --colour=auto -E -e '
79
Charles M.C. Chan870cc032015-04-24 04:57:42 +080080function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070081 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
82}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080083alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080084alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080085
86function filterLog {
87 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
88}
89alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070090alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070091
92# Pretty-print JSON output
93alias pp='python -m json.tool'
94
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070095# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070096alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070097alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -070098alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070099
Thomas Vachuska6066dff2016-10-26 13:57:36 -0700100# Short-hand for 'mvn clean install' for us lazy folk
101alias mci='mvn clean install'
102alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
103alias mis='mvn install -DskipTests -Dcheckstyle.skip'
104
105# Git annotated one-line log
106alias gil='git log --oneline --decorate=short'
tom5c255702014-09-18 06:57:39 -0700107
tom5a18e802014-09-18 12:38:15 -0700108# Test related conveniences
109
tom5a18e802014-09-18 12:38:15 -0700110# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -0700111alias sshctl='onos-ssh'
112alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -0700113
Thomas Vachuskae1125352016-11-09 14:06:51 -0800114# Runs a sequence of STC scenarios until the first failure.
115function stcs {
Thomas Vachuska8cc53182016-11-14 13:06:54 -0800116 for s in "$@"; do
117 if [[ $s =~ ^[0-9]*$ ]]; then
118 printf "Waiting %d seconds...\n" $s
119 sleep $s
120 else
121 printf "Running scenario %s...\n" $s
122 stc $s || return 1
123 fi
124 done
Thomas Vachuskae1125352016-11-09 14:06:51 -0800125}
Thomas Vachuska785f5812015-03-19 01:11:00 -0700126
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700127# Applies the settings in the specified topology recipe file or lists current
128# topo recipe definition if no topo recipe file is given.
129function topo {
130 topo=${1:-""}
131 case "$topo" in
132 "")
133 env | egrep "ONOS_TOPO"
134 env | egrep "(OTD|OTL|OTH)="
135 ;;
136
137 *)
138 [ ! -f $ONOS_ROOT/tools/test/topos/$1.recipe ] && echo "No such topo recipe: $1" >&2 && return 1
139 unset ONOS_TOPO OTD OTL OTH ONOS_DEVICES ONOS_HOSTS
140 unset $(env | sed -n 's:\(^OT[DLH][0-9]\{1,\}\)=.*:\1 :g p')
141 export ONOS_TOPO=$1
142 . $ONOS_ROOT/tools/test/topos/$1.recipe
143 let d=1; while [ $d -le $OTD ]; do
144 dev="$(printf 'of:%016x' $d)"
145 export OTD$d=$dev; export ONOS_DEVICES="$ONOS_DEVICES $dev"
146 let d=d+1;
147 done
148 let h=1; while [ $h -le $OTH ]; do
149 host="$(printf '00:00:00:00:00:%02x/-1' $h)"
150 export OTH$h=$host; export ONOS_HOSTS="$ONOS_HOSTS $host"
151 let h=h+1
152 done
153 topo
154 esac
155}
156
157# Lists available topo recipes
158function topos {
159 for topo in $(ls -1 $ONOS_ROOT/tools/test/topos/*.recipe); do
160 name=$(basename $topo .recipe)
161 printf "%-16s %s\n" \
162 "$([ $name = $ONOS_TOPO ] && echo $name '*' || echo $name)" \
163 "$(grep '^#' $topo | head -n 1)"
164 done
165}
166
Thomas Vachuska785f5812015-03-19 01:11:00 -0700167# Sets the primary instance to the specified instance number.
168function setPrimaryInstance {
Jon Hallee85e2f2016-06-07 10:36:33 -0700169 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700170 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
171 echo $OCI
172}
173
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700174# ON.Lab shared test cell warden address
175export CELL_WARDEN="10.254.1.19"
Thomas Vachuskab0734592017-07-18 17:13:01 -0700176export CELL_SLAVES="$CELL_WARDEN 10.254.1.18 10.254.1.17"
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700177
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700178# Clears cell environment
179function clearCell {
180 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
181 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
Charles Chanc7a60ce2017-05-05 13:56:27 -0700182 unset ONOS_USER ONOS_GROUP ONOS_WEB_USER ONOS_WEB_PASS
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700183 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
184}
185
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700186# Applies the settings in the specified cell file or lists current cell definition
187# if no cell file is given.
188function cell {
Jon Hall7dc59d62016-05-10 14:30:16 -0700189 cell=${1:-""}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700190 case "$cell" in
191 "borrow")
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700192 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700193 aux="/tmp/cell-$$"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700194 duration=${2:-0}
Thomas Vachuska5420ba32016-05-13 14:45:25 -0400195 spec=${3:-3+1}
196 spec=${spec/+/%2B}
197 user=${4:-$(id -un)}
Thomas Vachuska05e47a32016-10-24 09:35:11 -0700198 hint=${5}
199 query="duration=$duration&spec=$spec&user=$user&cellNameHint=$hint"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700200 curl -sS -X POST "http://$CELL_WARDEN:4321/?$query" -d "$(cat ~/.ssh/id_rsa.pub)" > $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700201 . $aux
202 rm -f $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700203 setPrimaryInstance 1 >/dev/null
204 onos-verify-cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700205 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700206 ;;
207 "return")
208 curl -sS -X DELETE "http://$CELL_WARDEN:4321/?user=${2:-$(id -un)}"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700209 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700210 ;;
211
212 "status")
213 curl -sS "http://$CELL_WARDEN:4321/" | sort
214 ;;
215
216 "")
Charles Chan9b152fc2016-11-21 12:06:49 -0800217 env | egrep "^ONOS_CELL"
218 env | egrep "^OCI"
219 env | egrep "^OC[0-9]+" | sort
220 env | egrep "^OC[NT]"
221 env | egrep "^ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES|ONOS_DEVICES|ONOS_HOSTS' | sort
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700222 ;;
223
224 *)
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700225 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && echo "No such cell: $1" >&2 && return 1
226 clearCell
Charles Chanc7a60ce2017-05-05 13:56:27 -0700227 export ONOS_USER=sdn
228 export ONOS_GROUP=sdn
229 export ONOS_WEB_USER=onos
230 export ONOS_WEB_PASS=rocks
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700231 export ONOS_CELL=$1
232 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700233 setPrimaryInstance 1 >/dev/null
234 cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700235 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700236 esac
237}
tomecd0fbd2014-09-19 08:47:05 -0700238
Thomas Vachuskae6185572016-05-04 19:26:15 -0700239[ -n "$ONOS_CELL" -a "$ONOS_CELL" != "borrow" ] && cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700240
241# Lists available cells
242function cells {
tom2482e6f2014-10-01 16:51:48 -0700243 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700244 printf "%-16s %s\n" \
Yi Tseng7f425d52017-02-02 13:33:59 -0800245 "$([ ! -z $ONOS_CELL ] && [ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
tom2482e6f2014-10-01 16:51:48 -0700246 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
247 done
tomecd0fbd2014-09-19 08:47:05 -0700248}
tom5a18e802014-09-18 12:38:15 -0700249
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800250# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700251function spy {
252 ps -ef | egrep "$@" | grep -v egrep
253}
254
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800255# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700256function nuke {
tom85258ee2014-10-07 00:10:02 -0700257 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700258}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800259
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700260# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
261function vicell {
262 local apply=false
263 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800264 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700265 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800266
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800267 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700268 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800269 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700270 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800271 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700272 printf "\t-c: create cell file if none exist\n\n"
273 return 1
274 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800275
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700276 while [ $# -gt 0 ]; do
277 case "$1" in
278 -a) apply=true ;;
279 -e) EDITOR=$2; shift ;;
280 -c) create=true ;;
281 *) cdf="$1" ;;
282 esac
283 shift
284 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800285
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800286 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700287 printf "${cdf} : no such cell\n" && return 1
288 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800289
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700290 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
291 unset EDITOR && vi ${cpath}${cdf}
292 else
293 $EDITOR ${cpath}${cdf}
294 fi
295 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800296}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800297
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800298# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800299. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800300
301
302# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800303alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800304
305# Load UK topo GEO data
306alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'