blob: 0f27638c2650ed556b0a44013870c19baafee863 [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
Jian Li11599162016-01-15 15:46:16 -080021export KARAF_VERSION=${KARAF_VERSION:-3.0.5}
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"
tom1cd74ae2014-10-01 14:58:32 -070028export PATH="$PATH:$ONOS_ROOT/tools/build"
Thomas Vachuska255b65f2014-11-23 14:25:31 -080029export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin"
tom6a9f2722014-09-13 17:00:02 -070030
Roan Huang0fa4bc42015-05-01 15:38:20 +080031# Setup cell enviroment
32export ONOS_CELL=${ONOS_CELL:-local}
33
Thomas Vachuskac3c969a2015-08-19 16:51:16 -070034# Setup default web user/password
35export ONOS_WEB_USER=onos
36export ONOS_WEB_PASS=rocks
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070037
Thomas Vachuska30301082016-11-19 08:03:01 -080038# Use raw SSH client for CLI console access by default
39export ONOS_USE_SSH=true
40
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070041# Setup default location of test scenarios
Thomas Vachuskae76f6532015-07-08 09:40:53 -070042export ONOS_SCENARIOS=$ONOS_ROOT/tools/test/scenarios
43
tom6a9f2722014-09-13 17:00:02 -070044# Convenience utility to warp to various ONOS source projects
45# e.g. 'o api', 'o dev', 'o'
46function o {
Ray Milkey33d81c62016-04-01 13:18:02 -070047 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 -080048 egrep "${1:-$ONOS_ROOT}" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070049}
50
Thomas Vachuska6066dff2016-10-26 13:57:36 -070051# Buck (if "buck" is not on the PATH)
52[ -z "$(which buck)" ] && alias buck="onos-buck"
tom6a9f2722014-09-13 17:00:02 -070053
tom82d6bde2014-09-23 17:33:58 -070054# Short-hand for ONOS build, package and test.
55alias ob='onos-build'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070056alias obf='(cd $ONOS_ROOT && buck build onos)'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080057alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070058alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070059alias ot='onos-test'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070060
61alias deprecatedAlias='echo "This alias has been deprecated."'
62alias obi=deprecatedAlias
63alias obs=deprecatedAlias
64
Thomas Vachuska10d1d1e2016-11-20 09:18:18 -080065alias ok='NO_BUCKD=1 buck run onos-local --'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070066alias oh='onos localhost halt'
67
tom0511a522014-10-04 12:06:02 -070068alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070069alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070070alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080071alias oi='setPrimaryInstance'
tom6a9f2722014-09-13 17:00:02 -070072
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070073# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070074alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070075alias gl='grep $KARAF_LOG --colour=auto -E -e '
76
Charles M.C. Chan870cc032015-04-24 04:57:42 +080077function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070078 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
79}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080080alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080081alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080082
83function filterLog {
84 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
85}
86alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070087alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070088
89# Pretty-print JSON output
90alias pp='python -m json.tool'
91
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070092# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070093alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070094alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -070095alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070096
Thomas Vachuska6066dff2016-10-26 13:57:36 -070097# Short-hand for 'mvn clean install' for us lazy folk
98alias mci='mvn clean install'
99alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
100alias mis='mvn install -DskipTests -Dcheckstyle.skip'
101
102# Git annotated one-line log
103alias gil='git log --oneline --decorate=short'
tom5c255702014-09-18 06:57:39 -0700104
tom5a18e802014-09-18 12:38:15 -0700105# Test related conveniences
106
tom5a18e802014-09-18 12:38:15 -0700107# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -0700108alias sshctl='onos-ssh'
109alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -0700110
Thomas Vachuskae1125352016-11-09 14:06:51 -0800111# Runs a sequence of STC scenarios until the first failure.
112function stcs {
Thomas Vachuska8cc53182016-11-14 13:06:54 -0800113 for s in "$@"; do
114 if [[ $s =~ ^[0-9]*$ ]]; then
115 printf "Waiting %d seconds...\n" $s
116 sleep $s
117 else
118 printf "Running scenario %s...\n" $s
119 stc $s || return 1
120 fi
121 done
Thomas Vachuskae1125352016-11-09 14:06:51 -0800122}
Thomas Vachuska785f5812015-03-19 01:11:00 -0700123
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700124# Applies the settings in the specified topology recipe file or lists current
125# topo recipe definition if no topo recipe file is given.
126function topo {
127 topo=${1:-""}
128 case "$topo" in
129 "")
130 env | egrep "ONOS_TOPO"
131 env | egrep "(OTD|OTL|OTH)="
132 ;;
133
134 *)
135 [ ! -f $ONOS_ROOT/tools/test/topos/$1.recipe ] && echo "No such topo recipe: $1" >&2 && return 1
136 unset ONOS_TOPO OTD OTL OTH ONOS_DEVICES ONOS_HOSTS
137 unset $(env | sed -n 's:\(^OT[DLH][0-9]\{1,\}\)=.*:\1 :g p')
138 export ONOS_TOPO=$1
139 . $ONOS_ROOT/tools/test/topos/$1.recipe
140 let d=1; while [ $d -le $OTD ]; do
141 dev="$(printf 'of:%016x' $d)"
142 export OTD$d=$dev; export ONOS_DEVICES="$ONOS_DEVICES $dev"
143 let d=d+1;
144 done
145 let h=1; while [ $h -le $OTH ]; do
146 host="$(printf '00:00:00:00:00:%02x/-1' $h)"
147 export OTH$h=$host; export ONOS_HOSTS="$ONOS_HOSTS $host"
148 let h=h+1
149 done
150 topo
151 esac
152}
153
154# Lists available topo recipes
155function topos {
156 for topo in $(ls -1 $ONOS_ROOT/tools/test/topos/*.recipe); do
157 name=$(basename $topo .recipe)
158 printf "%-16s %s\n" \
159 "$([ $name = $ONOS_TOPO ] && echo $name '*' || echo $name)" \
160 "$(grep '^#' $topo | head -n 1)"
161 done
162}
163
Thomas Vachuska785f5812015-03-19 01:11:00 -0700164# Sets the primary instance to the specified instance number.
165function setPrimaryInstance {
Jon Hallee85e2f2016-06-07 10:36:33 -0700166 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700167 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
168 echo $OCI
169}
170
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700171# ON.Lab shared test cell warden address
172export CELL_WARDEN="10.254.1.19"
173
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700174# Clears cell environment
175function clearCell {
176 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
177 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
178 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
179}
180
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700181# Applies the settings in the specified cell file or lists current cell definition
182# if no cell file is given.
183function cell {
Jon Hall7dc59d62016-05-10 14:30:16 -0700184 cell=${1:-""}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700185 case "$cell" in
186 "borrow")
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700187 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700188 aux="/tmp/cell-$$"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700189 duration=${2:-0}
Thomas Vachuska5420ba32016-05-13 14:45:25 -0400190 spec=${3:-3+1}
191 spec=${spec/+/%2B}
192 user=${4:-$(id -un)}
Thomas Vachuska05e47a32016-10-24 09:35:11 -0700193 hint=${5}
194 query="duration=$duration&spec=$spec&user=$user&cellNameHint=$hint"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700195 curl -sS -X POST "http://$CELL_WARDEN:4321/?$query" -d "$(cat ~/.ssh/id_rsa.pub)" > $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700196 . $aux
197 rm -f $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700198 setPrimaryInstance 1 >/dev/null
199 onos-verify-cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700200 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700201 ;;
202 "return")
203 curl -sS -X DELETE "http://$CELL_WARDEN:4321/?user=${2:-$(id -un)}"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700204 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700205 ;;
206
207 "status")
208 curl -sS "http://$CELL_WARDEN:4321/" | sort
209 ;;
210
211 "")
Charles Chan9b152fc2016-11-21 12:06:49 -0800212 env | egrep "^ONOS_CELL"
213 env | egrep "^OCI"
214 env | egrep "^OC[0-9]+" | sort
215 env | egrep "^OC[NT]"
216 env | egrep "^ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES|ONOS_DEVICES|ONOS_HOSTS' | sort
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700217 ;;
218
219 *)
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700220 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && echo "No such cell: $1" >&2 && return 1
221 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700222 export ONOS_USER=${ONOS_USER:-sdn}
223 export ONOS_GROUP=${ONOS_GROUP:-sdn}
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700224 export ONOS_WEB_USER=${ONOS_WEB_USER:-onos}
225 export ONOS_WEB_PASS=${ONOS_WEB_PASS:-rocks}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700226 export ONOS_CELL=$1
227 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700228 setPrimaryInstance 1 >/dev/null
229 cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700230 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700231 esac
232}
tomecd0fbd2014-09-19 08:47:05 -0700233
Thomas Vachuskae6185572016-05-04 19:26:15 -0700234[ -n "$ONOS_CELL" -a "$ONOS_CELL" != "borrow" ] && cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700235
236# Lists available cells
237function cells {
tom2482e6f2014-10-01 16:51:48 -0700238 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700239 printf "%-16s %s\n" \
tom2482e6f2014-10-01 16:51:48 -0700240 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
241 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
242 done
tomecd0fbd2014-09-19 08:47:05 -0700243}
tom5a18e802014-09-18 12:38:15 -0700244
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800245# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700246function spy {
247 ps -ef | egrep "$@" | grep -v egrep
248}
249
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800250# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700251function nuke {
tom85258ee2014-10-07 00:10:02 -0700252 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700253}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800254
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700255# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
256function vicell {
257 local apply=false
258 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800259 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700260 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800261
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800262 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700263 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800264 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700265 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800266 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700267 printf "\t-c: create cell file if none exist\n\n"
268 return 1
269 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800270
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700271 while [ $# -gt 0 ]; do
272 case "$1" in
273 -a) apply=true ;;
274 -e) EDITOR=$2; shift ;;
275 -c) create=true ;;
276 *) cdf="$1" ;;
277 esac
278 shift
279 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800280
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800281 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700282 printf "${cdf} : no such cell\n" && return 1
283 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800284
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700285 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
286 unset EDITOR && vi ${cpath}${cdf}
287 else
288 $EDITOR ${cpath}${cdf}
289 fi
290 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800291}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800292
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800293# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800294. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800295
296
297# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800298alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800299
300# Load UK topo GEO data
301alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'