blob: 673efd8f3672fee0866bab944017db608b5448ca [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"
Pavlin Radoslavov93617212014-10-16 09:54:04 -070014 elif [ -d /usr/lib/jvm/java-7-openjdk-amd64 ]; then
15 export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"
16 fi
17fi
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070018
Charles M.C. Chane5b610e2015-03-19 17:23:16 +080019export MAVEN=${MAVEN:-~/Applications/apache-maven-3.3.1}
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070020
Thomas Vachuska5630c612015-03-24 12:24:12 -070021export KARAF_VERSION=${KARAF_VERSION:-3.0.3}
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
tom1cd74ae2014-10-01 14:58:32 -070026export PATH="$PATH:$ONOS_ROOT/tools/dev/bin:$ONOS_ROOT/tools/test/bin"
27export PATH="$PATH:$ONOS_ROOT/tools/build"
Thomas Vachuska255b65f2014-11-23 14:25:31 -080028export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin"
tom6a9f2722014-09-13 17:00:02 -070029
Roan Huang0fa4bc42015-05-01 15:38:20 +080030# Setup cell enviroment
31export ONOS_CELL=${ONOS_CELL:-local}
32
tom6a9f2722014-09-13 17:00:02 -070033# Convenience utility to warp to various ONOS source projects
34# e.g. 'o api', 'o dev', 'o'
35function o {
tomcf8dd2a2014-10-10 08:37:20 -070036 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|gen-src' | \
tom9a693fd2014-10-03 11:32:19 -070037 egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070038}
39
40# Short-hand for 'mvn clean install' for us lazy folk
41alias mci='mvn clean install'
Yuta HIGUCHI007cdff2014-11-20 13:39:05 -080042alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip -U -T 1C'
43alias mis='mvn install -DskipTests -Dcheckstyle.skip -U -T 1C'
tom6a9f2722014-09-13 17:00:02 -070044
tom82d6bde2014-09-23 17:33:58 -070045# Short-hand for ONOS build, package and test.
46alias ob='onos-build'
Thomas Vachuskad16ce182014-10-29 17:25:29 -070047alias obi='onos-build -Dmaven.test.failure.ignore=true'
tom1cd74ae2014-10-01 14:58:32 -070048alias obs='onos-build-selective'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080049alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070050alias op='onos-package'
Thomas Vachuskafcd61142015-04-23 13:59:08 -070051alias ok='onos-karaf'
tomcaf3bf72014-09-23 13:20:53 -070052alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070053alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070054alias ow='onos-watch'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070055alias ocl='onos-check-logs'
Thomas Vachuska85314292014-11-14 17:52:12 -080056alias oi='setPrimaryInstance'
tomca8f6702014-10-07 09:28:53 -070057alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070058
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070059# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070060alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Jonathan Hartd57df6c2014-10-17 15:18:02 -070061alias ll='less $KARAF_LOG'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070062alias gl='grep $KARAF_LOG --colour=auto -E -e '
63
Charles M.C. Chan870cc032015-04-24 04:57:42 +080064function filterLocalLog {
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070065 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
66}
Charles M.C. Chan870cc032015-04-24 04:57:42 +080067alias tlo='filterLocalLog'
Charles M.C. Chane39f3142015-05-22 18:35:24 +080068alias tle='tlo "ERROR|WARN|Exception|Error"'
Charles M.C. Chan870cc032015-04-24 04:57:42 +080069
70function filterLog {
71 ol | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
72}
73alias olo='filterLog'
Thomas Vachuska3cd677d2015-05-20 11:25:49 -070074alias ole='olo "ERROR|WARN|Exception|Error"'
tom6a9f2722014-09-13 17:00:02 -070075
76# Pretty-print JSON output
77alias pp='python -m json.tool'
78
79# Short-hand to launch API docs and sample topology viewer GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070080alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
tom1a2908c2014-09-23 16:37:39 -070081alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070082
83
tom5a18e802014-09-18 12:38:15 -070084# Test related conveniences
85
tom5a18e802014-09-18 12:38:15 -070086# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070087alias sshctl='onos-ssh'
88alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070089
Thomas Vachuska785f5812015-03-19 01:11:00 -070090
91# Sets the primary instance to the specified instance number.
92function setPrimaryInstance {
93 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
94 echo $OCI
95}
96
tomecd0fbd2014-09-19 08:47:05 -070097# Applies the settings in the specified cell file or lists current cell definition
98# if no cell file is given.
99function cell {
100 if [ -n "$1" ]; then
101 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
102 echo "No such cell: $1" >&2 && return 1
Charles M.C. Chan1d003e92015-05-21 10:08:30 +0800103 unset ONOS_CELL ONOS_NIC ONOS_IP ONOS_APPS ONOS_BOOT_FEATURES ONOS_USER ONOS_GROUP
Thomas Vachuska785f5812015-03-19 01:11:00 -0700104 unset OCI OCN OCT
105 unset ONOS_FEATURES # deprecated
Ayaka Koshibeebb54442015-01-09 14:22:19 -0800106 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
Thomas Vachuskacce11ca2014-10-16 11:52:29 -0700107 export ONOS_CELL=$1
tomecd0fbd2014-09-19 08:47:05 -0700108 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuska785f5812015-03-19 01:11:00 -0700109 setPrimaryInstance 1 >/dev/null
tomecd0fbd2014-09-19 08:47:05 -0700110 cell
111 else
112 env | egrep "ONOS_CELL"
113 env | egrep "OCI"
Pavlin Radoslavov711145a2014-10-16 17:45:48 -0700114 env | egrep "OC[0-9]+" | sort
Thomas Vachuska785f5812015-03-19 01:11:00 -0700115 env | egrep "OC[NT]"
tome797a5d2014-09-30 11:57:50 -0700116 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL'
tomecd0fbd2014-09-19 08:47:05 -0700117 fi
118}
119
Roan Huang0fa4bc42015-05-01 15:38:20 +0800120cell $ONOS_CELL > /dev/null
tomecd0fbd2014-09-19 08:47:05 -0700121
122# Lists available cells
123function cells {
tom2482e6f2014-10-01 16:51:48 -0700124 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700125 printf "%-16s %s\n" \
tom2482e6f2014-10-01 16:51:48 -0700126 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
127 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
128 done
tomecd0fbd2014-09-19 08:47:05 -0700129}
tom5a18e802014-09-18 12:38:15 -0700130
tom5c255702014-09-18 06:57:39 -0700131# Miscellaneous
132function spy {
133 ps -ef | egrep "$@" | grep -v egrep
134}
135
136function nuke {
tom85258ee2014-10-07 00:10:02 -0700137 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700138}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800139
140# Edit a cell file by providing a cell name. Opens the cell file in $EDITOR.
141function vicell() {
142 local apply=false
143 local create=false
144 local cdf=""
145 local cpath="${ONOS_ROOT}/tools/test/cells/"
146
147 if [ -z "$1" ] || [ "$1" = "-h" ] ; then
148 printf "usage: vicell [file] [options]\n\noptions:\n"
149 printf "\t-a: apply the cell after editing\n"
150 printf "\t-e: [editor] set EDITOR to [editor] (default *vi*)\n"
151 printf "\t-c: create cell file if none exist\n\n"
152 return 1
153 fi
154
155 while [ $# -gt 0 ]; do
156 case "$1" in
157 -a) apply=true ;;
158 -e) EDITOR=$2; shift ;;
159 -c) create=true ;;
160 *) cdf="$1" ;;
161 esac
162 shift
163 done
164
165 if [ ! -e "${cpath}${cdf}" ] && [ "$create" = "false" ]; then
166 printf "${cdf} : no such cell\n" && return 1
167 fi
168
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800169 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
170 unset EDITOR && vi ${cpath}${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800171 else
172 $EDITOR ${cpath}${cdf}
173 fi
174 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800175}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800176
177# autocomplete for certain utilities
178. ${ONOS_ROOT}/tools/test/bin/ogroup-opts