blob: 81252ce0ba9d58e1e84979ae48c3fb15098c3f40 [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
38# Setup default location of test scenarios
Thomas Vachuskae76f6532015-07-08 09:40:53 -070039export ONOS_SCENARIOS=$ONOS_ROOT/tools/test/scenarios
40
tom6a9f2722014-09-13 17:00:02 -070041# Convenience utility to warp to various ONOS source projects
42# e.g. 'o api', 'o dev', 'o'
43function o {
Ray Milkey33d81c62016-04-01 13:18:02 -070044 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 -080045 egrep "${1:-$ONOS_ROOT}" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070046}
47
48# Short-hand for 'mvn clean install' for us lazy folk
49alias mci='mvn clean install'
Michele Santuari91ee01b2016-04-04 17:04:46 -070050alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip'
51alias mis='mvn install -DskipTests -Dcheckstyle.skip'
tom6a9f2722014-09-13 17:00:02 -070052
tom82d6bde2014-09-23 17:33:58 -070053# Short-hand for ONOS build, package and test.
54alias ob='onos-build'
Thomas Vachuska1e60f972015-10-19 09:55:52 -070055alias obf='ob -DskipTests -Dcheckstyle.skip'
Thomas Vachuskad16ce182014-10-29 17:25:29 -070056alias obi='onos-build -Dmaven.test.failure.ignore=true'
tom1cd74ae2014-10-01 14:58:32 -070057alias obs='onos-build-selective'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080058alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070059alias op='onos-package'
Thomas Vachuskafcd61142015-04-23 13:59:08 -070060alias ok='onos-karaf'
tomcaf3bf72014-09-23 13:20:53 -070061alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070062alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070063alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070064alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080065alias oi='setPrimaryInstance'
tomca8f6702014-10-07 09:28:53 -070066alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070067
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070068# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070069alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070070alias gl='grep $KARAF_LOG --colour=auto -E -e '
71
Charles M.C. Chan870cc032015-04-24 04:57:42 +080072function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070073 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
74}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080075alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080076alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080077
78function filterLog {
79 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
80}
81alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070082alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070083
84# Pretty-print JSON output
85alias pp='python -m json.tool'
86
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070087# Short-hand to launch Java API docs, REST API docs and ONOS GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070088alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
Thomas Vachuskaaf0ee532015-08-19 14:17:36 -070089alias rsdocs='onos-rsdocs'
tom1a2908c2014-09-23 16:37:39 -070090alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070091
92
tom5a18e802014-09-18 12:38:15 -070093# Test related conveniences
94
tom5a18e802014-09-18 12:38:15 -070095# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070096alias sshctl='onos-ssh'
97alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070098
Thomas Vachuska785f5812015-03-19 01:11:00 -070099
100# Sets the primary instance to the specified instance number.
101function setPrimaryInstance {
102 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
103 echo $OCI
104}
105
tomecd0fbd2014-09-19 08:47:05 -0700106# Applies the settings in the specified cell file or lists current cell definition
107# if no cell file is given.
108function cell {
109 if [ -n "$1" ]; then
110 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
111 echo "No such cell: $1" >&2 && return 1
Thomas Vachuska0a4c2702015-07-06 08:43:41 -0700112 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES
Bob Lantz53228832016-04-15 15:00:43 -0700113 unset OCI OCN OCT ONOS_INSTANCES ONOS_FEATURES
Ayaka Koshibeebb54442015-01-09 14:22:19 -0800114 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
Thomas Vachuska330aef12015-10-15 12:00:33 -0700115 export ONOS_USER=${ONOS_USER:-sdn}
Bob Lantze7b43032016-02-25 04:02:24 -0800116 export ONOS_GROUP=${ONOS_GROUP:-sdn}
Thomas Vachuska3c831fa2015-08-17 18:44:15 -0700117 export ONOS_WEB_USER=onos
118 export ONOS_WEB_PASS=rocks
Thomas Vachuskacce11ca2014-10-16 11:52:29 -0700119 export ONOS_CELL=$1
tomecd0fbd2014-09-19 08:47:05 -0700120 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuska0a4c2702015-07-06 08:43:41 -0700121 export ONOS_INSTANCES=$(env | grep 'OC[0-9]*=' | sort | cut -d= -f2)
Thomas Vachuska785f5812015-03-19 01:11:00 -0700122 setPrimaryInstance 1 >/dev/null
tomecd0fbd2014-09-19 08:47:05 -0700123 cell
124 else
125 env | egrep "ONOS_CELL"
126 env | egrep "OCI"
Pavlin Radoslavov711145a2014-10-16 17:45:48 -0700127 env | egrep "OC[0-9]+" | sort
Thomas Vachuska785f5812015-03-19 01:11:00 -0700128 env | egrep "OC[NT]"
Thomas Vachuska3c831fa2015-08-17 18:44:15 -0700129 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL|ONOS_INSTANCES' | sort
tomecd0fbd2014-09-19 08:47:05 -0700130 fi
131}
132
Roan Huang0fa4bc42015-05-01 15:38:20 +0800133cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700134
135# Lists available cells
136function cells {
tom2482e6f2014-10-01 16:51:48 -0700137 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700138 printf "%-16s %s\n" \
tom2482e6f2014-10-01 16:51:48 -0700139 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
140 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
141 done
tomecd0fbd2014-09-19 08:47:05 -0700142}
tom5a18e802014-09-18 12:38:15 -0700143
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800144# Find a process by regex
tom5c255702014-09-18 06:57:39 -0700145function spy {
146 ps -ef | egrep "$@" | grep -v egrep
147}
148
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800149# Kill a process by regex
tom5c255702014-09-18 06:57:39 -0700150function nuke {
tom85258ee2014-10-07 00:10:02 -0700151 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700152}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800153
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700154# Edit a cell file by providing a cell name; opens the cell file in $EDITOR.
155function vicell {
156 local apply=false
157 local create=false
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800158 local ${cdf:=$ONOS_CELL}
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700159 local cpath="${ONOS_ROOT}/tools/test/cells/"
Ayaka Koshibea9985132014-12-18 14:55:22 -0800160
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800161 if [ "$1" = "-h" ] ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700162 printf "usage: vicell [file] [options]\n\noptions:\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800163 printf "\t[file]: cell name (default: current cell)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700164 printf "\t-a: apply the cell after editing\n"
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800165 printf "\t-e: [editor] set EDITOR to [editor] (default: *vi*)\n"
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700166 printf "\t-c: create cell file if none exist\n\n"
167 return 1
168 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800169
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700170 while [ $# -gt 0 ]; do
171 case "$1" in
172 -a) apply=true ;;
173 -e) EDITOR=$2; shift ;;
174 -c) create=true ;;
175 *) cdf="$1" ;;
176 esac
177 shift
178 done
Ayaka Koshibea9985132014-12-18 14:55:22 -0800179
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800180 if [ ! -e "${cpath}${cdf}" ] && ! ($create) ; then
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700181 printf "${cdf} : no such cell\n" && return 1
182 fi
Ayaka Koshibea9985132014-12-18 14:55:22 -0800183
Thomas Vachuskaea2d9fd2015-09-23 13:13:25 -0700184 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
185 unset EDITOR && vi ${cpath}${cdf}
186 else
187 $EDITOR ${cpath}${cdf}
188 fi
189 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800190}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800191
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800192# Autocomplete for certain utilities
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800193. ${ONOS_ROOT}/tools/test/bin/ogroup-opts
Thomas Vachuska9507d2a2015-12-01 20:45:57 -0800194
195
196# Load AT&T MPLS topo GEO data
Ayaka Koshibe77acdc72016-02-03 17:19:24 -0800197alias atttopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/attmpls-cfg.json'
Simon Huntcf7e3b52016-02-29 23:26:16 -0800198
199# Load UK topo GEO data
200alias uktopo='onos-netcfg $OCI $ONOS_ROOT/tools/test/topos/uk-cfg.json'
Brian O'Connor9be23632016-04-08 18:23:45 -0700201
202# Git annotated one-line log
203alias gil='git log --oneline --decorate=short'
204
205# Buck (if "buck" is not on the PATH)
206[ -z "$(which buck)" ] && alias buck="onos-buck"