blob: 6308334d99dfd8317163331a2604e8433ba16027 [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"
Ray Milkey5c0d8f92017-06-09 12:26:31 -070028export PATH="$ONOS_ROOT/tools/package/runtime/bin:$PATH"
tom1cd74ae2014-10-01 14:58:32 -070029export PATH="$PATH:$ONOS_ROOT/tools/build"
Thomas Vachuska255b65f2014-11-23 14:25:31 -080030export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin"
tom6a9f2722014-09-13 17:00:02 -070031
Roan Huang0fa4bc42015-05-01 15:38:20 +080032# Setup cell enviroment
33export ONOS_CELL=${ONOS_CELL:-local}
34
Thomas Vachuskac3c969a2015-08-19 16:51:16 -070035# Setup default web user/password
36export ONOS_WEB_USER=onos
37export ONOS_WEB_PASS=rocks
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070038
39# Setup default location of test scenarios
Thomas Vachuskae76f6532015-07-08 09:40:53 -070040export ONOS_SCENARIOS=$ONOS_ROOT/tools/test/scenarios
41
Carmelo Casconeb7524272017-06-05 16:53:13 -040042# Setup path to Mininet custom scripts
43export ONOS_MN_PY=$ONOS_ROOT/tools/dev/mininet/onos.py
44export BMV2_MN_PY=$ONOS_ROOT/tools/dev/mininet/bmv2.py
45
tom6a9f2722014-09-13 17:00:02 -070046# Convenience utility to warp to various ONOS source projects
47# e.g. 'o api', 'o dev', 'o'
48function o {
Ray Milkey33d81c62016-04-01 13:18:02 -070049 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 -080050 egrep "${1:-$ONOS_ROOT}" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070051}
52
Thomas Vachuska6066dff2016-10-26 13:57:36 -070053# Buck (if "buck" is not on the PATH)
54[ -z "$(which buck)" ] && alias buck="onos-buck"
tom6a9f2722014-09-13 17:00:02 -070055
tom82d6bde2014-09-23 17:33:58 -070056# Short-hand for ONOS build, package and test.
57alias ob='onos-build'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070058alias obf='(cd $ONOS_ROOT && buck build onos)'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080059alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070060alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070061alias ot='onos-test'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070062
63alias deprecatedAlias='echo "This alias has been deprecated."'
64alias obi=deprecatedAlias
65alias obs=deprecatedAlias
66
Thomas Vachuska10d1d1e2016-11-20 09:18:18 -080067alias ok='NO_BUCKD=1 buck run onos-local --'
Thomas Vachuska6066dff2016-10-26 13:57:36 -070068alias oh='onos localhost halt'
69
tom0511a522014-10-04 12:06:02 -070070alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070071alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070072alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080073alias oi='setPrimaryInstance'
tom6a9f2722014-09-13 17:00:02 -070074
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070075# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070076alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070077alias gl='grep $KARAF_LOG --colour=auto -E -e '
78
Charles M.C. Chan870cc032015-04-24 04:57:42 +080079function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070080 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
81}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080082alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080083alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080084
85function filterLog {
86 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
87}
88alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070089alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070090
91# Pretty-print JSON output
92alias pp='python -m json.tool'
93
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070094# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070095alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070096alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -070097alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070098
Thomas Vachuska6066dff2016-10-26 13:57:36 -070099# Short-hand for 'mvn clean install' for us lazy folk
100alias mci='mvn clean install'
101alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
102alias mis='mvn install -DskipTests -Dcheckstyle.skip'
103
104# Git annotated one-line log
105alias gil='git log --oneline --decorate=short'
tom5c255702014-09-18 06:57:39 -0700106
tom5a18e802014-09-18 12:38:15 -0700107# Test related conveniences
108
tom5a18e802014-09-18 12:38:15 -0700109# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -0700110alias sshctl='onos-ssh'
111alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -0700112
Thomas Vachuskae1125352016-11-09 14:06:51 -0800113# Runs a sequence of STC scenarios until the first failure.
114function stcs {
Thomas Vachuska8cc53182016-11-14 13:06:54 -0800115 for s in "$@"; do
116 if [[ $s =~ ^[0-9]*$ ]]; then
117 printf "Waiting %d seconds...\n" $s
118 sleep $s
119 else
120 printf "Running scenario %s...\n" $s
121 stc $s || return 1
122 fi
123 done
Thomas Vachuskae1125352016-11-09 14:06:51 -0800124}
Thomas Vachuska785f5812015-03-19 01:11:00 -0700125
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700126# Applies the settings in the specified topology recipe file or lists current
127# topo recipe definition if no topo recipe file is given.
128function topo {
129 topo=${1:-""}
130 case "$topo" in
131 "")
132 env | egrep "ONOS_TOPO"
133 env | egrep "(OTD|OTL|OTH)="
134 ;;
135
136 *)
137 [ ! -f $ONOS_ROOT/tools/test/topos/$1.recipe ] && echo "No such topo recipe: $1" >&2 && return 1
138 unset ONOS_TOPO OTD OTL OTH ONOS_DEVICES ONOS_HOSTS
139 unset $(env | sed -n 's:\(^OT[DLH][0-9]\{1,\}\)=.*:\1 :g p')
140 export ONOS_TOPO=$1
141 . $ONOS_ROOT/tools/test/topos/$1.recipe
142 let d=1; while [ $d -le $OTD ]; do
143 dev="$(printf 'of:%016x' $d)"
144 export OTD$d=$dev; export ONOS_DEVICES="$ONOS_DEVICES $dev"
145 let d=d+1;
146 done
147 let h=1; while [ $h -le $OTH ]; do
148 host="$(printf '00:00:00:00:00:%02x/-1' $h)"
149 export OTH$h=$host; export ONOS_HOSTS="$ONOS_HOSTS $host"
150 let h=h+1
151 done
152 topo
153 esac
154}
155
156# Lists available topo recipes
157function topos {
158 for topo in $(ls -1 $ONOS_ROOT/tools/test/topos/*.recipe); do
159 name=$(basename $topo .recipe)
160 printf "%-16s %s\n" \
161 "$([ $name = $ONOS_TOPO ] && echo $name '*' || echo $name)" \
162 "$(grep '^#' $topo | head -n 1)"
163 done
164}
165
Thomas Vachuska785f5812015-03-19 01:11:00 -0700166# Sets the primary instance to the specified instance number.
167function setPrimaryInstance {
Jon Hallee85e2f2016-06-07 10:36:33 -0700168 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700169 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
170 echo $OCI
171}
172
Thomas Vachuska1eff3a62016-05-03 01:07:24 -0700173# ON.Lab shared test cell warden address
174export CELL_WARDEN="10.254.1.19"
175
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700176# Clears cell environment
177function clearCell {
178 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
179 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
Charles Chanc7a60ce2017-05-05 13:56:27 -0700180 unset ONOS_USER ONOS_GROUP ONOS_WEB_USER ONOS_WEB_PASS
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700181 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
182}
183
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700184# Applies the settings in the specified cell file or lists current cell definition
185# if no cell file is given.
186function cell {
Jon Hall7dc59d62016-05-10 14:30:16 -0700187 cell=${1:-""}
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700188 case "$cell" in
189 "borrow")
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700190 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700191 aux="/tmp/cell-$$"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700192 duration=${2:-0}
Thomas Vachuska5420ba32016-05-13 14:45:25 -0400193 spec=${3:-3+1}
194 spec=${spec/+/%2B}
195 user=${4:-$(id -un)}
Thomas Vachuska05e47a32016-10-24 09:35:11 -0700196 hint=${5}
197 query="duration=$duration&spec=$spec&user=$user&cellNameHint=$hint"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700198 curl -sS -X POST "http://$CELL_WARDEN:4321/?$query" -d "$(cat ~/.ssh/id_rsa.pub)" > $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700199 . $aux
200 rm -f $aux
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700201 setPrimaryInstance 1 >/dev/null
202 onos-verify-cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700203 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700204 ;;
205 "return")
206 curl -sS -X DELETE "http://$CELL_WARDEN:4321/?user=${2:-$(id -un)}"
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700207 clearCell
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700208 ;;
209
210 "status")
211 curl -sS "http://$CELL_WARDEN:4321/" | sort
212 ;;
213
214 "")
Charles Chan9b152fc2016-11-21 12:06:49 -0800215 env | egrep "^ONOS_CELL"
216 env | egrep "^OCI"
217 env | egrep "^OC[0-9]+" | sort
218 env | egrep "^OC[NT]"
219 env | egrep "^ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES|ONOS_DEVICES|ONOS_HOSTS' | sort
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700220 ;;
221
222 *)
Thomas Vachuskafdeda922016-05-16 11:37:00 -0700223 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && echo "No such cell: $1" >&2 && return 1
224 clearCell
Charles Chanc7a60ce2017-05-05 13:56:27 -0700225 export ONOS_USER=sdn
226 export ONOS_GROUP=sdn
227 export ONOS_WEB_USER=onos
228 export ONOS_WEB_PASS=rocks
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700229 export ONOS_CELL=$1
230 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700231 setPrimaryInstance 1 >/dev/null
232 cell
Thomas Vachuskacc0b7d62016-07-12 14:03:11 -0700233 topo default >/dev/null
Thomas Vachuskaf07ec212016-05-10 12:17:40 -0700234 esac
235}
tomecd0fbd2014-09-19 08:47:05 -0700236
Thomas Vachuskae6185572016-05-04 19:26:15 -0700237[ -n "$ONOS_CELL" -a "$ONOS_CELL" != "borrow" ] && cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700238
239# Lists available cells
240function cells {
tom2482e6f2014-10-01 16:51:48 -0700241 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700242 printf "%-16s %s\n" \
Yi Tseng7f425d52017-02-02 13:33:59 -0800243 "$([ ! -z $ONOS_CELL ] && [ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
tom2482e6f2014-10-01 16:51:48 -0700244 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
245 done
tomecd0fbd2014-09-19 08:47:05 -0700246}
tom5a18e802014-09-18 12:38:15 -0700247
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800248# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700249function spy {
250 ps -ef | egrep "$@" | grep -v egrep
251}
252
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800253# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700254function nuke {
tom85258ee2014-10-07 00:10:02 -0700255 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700256}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800257
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700258# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
259function vicell {
260 local apply=false
261 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800262 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700263 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800264
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800265 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700266 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800267 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700268 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800269 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700270 printf "\t-c: create cell file if none exist\n\n"
271 return 1
272 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800273
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700274 while [ $# -gt 0 ]; do
275 case "$1" in
276 -a) apply=true ;;
277 -e) EDITOR=$2; shift ;;
278 -c) create=true ;;
279 *) cdf="$1" ;;
280 esac
281 shift
282 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800283
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800284 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700285 printf "${cdf} : no such cell\n" && return 1
286 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800287
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700288 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
289 unset EDITOR && vi ${cpath}${cdf}
290 else
291 $EDITOR ${cpath}${cdf}
292 fi
293 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800294}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800295
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800296# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800297. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800298
299
300# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800301alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800302
303# Load UK topo GEO data
304alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'