blob: cd6778f1c73c14b797c4d129003ffeea19e96a00 [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
30# Convenience utility to warp to various ONOS source projects
31# e.g. 'o api', 'o dev', 'o'
32function o {
tomcf8dd2a2014-10-10 08:37:20 -070033 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|gen-src' | \
tom9a693fd2014-10-03 11:32:19 -070034 egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070035}
36
37# Short-hand for 'mvn clean install' for us lazy folk
38alias mci='mvn clean install'
Yuta HIGUCHI007cdff2014-11-20 13:39:05 -080039alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip -U -T 1C'
40alias mis='mvn install -DskipTests -Dcheckstyle.skip -U -T 1C'
tom6a9f2722014-09-13 17:00:02 -070041
tom82d6bde2014-09-23 17:33:58 -070042# Short-hand for ONOS build, package and test.
43alias ob='onos-build'
Thomas Vachuskad16ce182014-10-29 17:25:29 -070044alias obi='onos-build -Dmaven.test.failure.ignore=true'
tom1cd74ae2014-10-01 14:58:32 -070045alias obs='onos-build-selective'
Thomas Vachuska7cbfd4f2014-11-04 18:22:49 -080046alias obd='onos-build-docs'
tom82d6bde2014-09-23 17:33:58 -070047alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070048alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070049alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070050alias ow='onos-watch'
Thomas Vachuska85314292014-11-14 17:52:12 -080051alias oi='setPrimaryInstance'
Sho SHIMIZUc02c0b82014-12-12 10:25:24 -080052# alias go='ob && ot && onos -w'
tomca8f6702014-10-07 09:28:53 -070053alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070054
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070055# Short-hand for tailing and searching the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070056alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
Jonathan Hartd57df6c2014-10-17 15:18:02 -070057alias ll='less $KARAF_LOG'
Thomas Vachuska152f9fd2015-04-02 16:28:13 -070058alias gl='grep $KARAF_LOG --colour=auto -E -e '
59
60function filterLog {
61 tl | grep --colour=always -E -e "${1-org.onlab|org.onosproject}"
62}
63alias tlo='filterLog'
tom6a9f2722014-09-13 17:00:02 -070064
65# Pretty-print JSON output
66alias pp='python -m json.tool'
67
68# Short-hand to launch API docs and sample topology viewer GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070069alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
tom1a2908c2014-09-23 16:37:39 -070070alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070071
72
tom5a18e802014-09-18 12:38:15 -070073# Test related conveniences
74
tom5a18e802014-09-18 12:38:15 -070075# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070076alias sshctl='onos-ssh'
77alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070078
Thomas Vachuska785f5812015-03-19 01:11:00 -070079
80# Sets the primary instance to the specified instance number.
81function setPrimaryInstance {
82 export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2)
83 echo $OCI
84}
85
tomecd0fbd2014-09-19 08:47:05 -070086# Applies the settings in the specified cell file or lists current cell definition
87# if no cell file is given.
88function cell {
89 if [ -n "$1" ]; then
90 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
91 echo "No such cell: $1" >&2 && return 1
Thomas Vachuska785f5812015-03-19 01:11:00 -070092 unset ONOS_CELL ONOS_NIC ONOS_APPS ONOS_BOOT_FEATURES ONOS_USER ONOS_GROUP
93 unset OCI OCN OCT
94 unset ONOS_FEATURES # deprecated
Ayaka Koshibeebb54442015-01-09 14:22:19 -080095 unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p')
Thomas Vachuskacce11ca2014-10-16 11:52:29 -070096 export ONOS_CELL=$1
tomecd0fbd2014-09-19 08:47:05 -070097 . $ONOS_ROOT/tools/test/cells/$1
Thomas Vachuska785f5812015-03-19 01:11:00 -070098 setPrimaryInstance 1 >/dev/null
tomecd0fbd2014-09-19 08:47:05 -070099 cell
100 else
101 env | egrep "ONOS_CELL"
102 env | egrep "OCI"
Pavlin Radoslavov711145a2014-10-16 17:45:48 -0700103 env | egrep "OC[0-9]+" | sort
Thomas Vachuska785f5812015-03-19 01:11:00 -0700104 env | egrep "OC[NT]"
tome797a5d2014-09-30 11:57:50 -0700105 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL'
tomecd0fbd2014-09-19 08:47:05 -0700106 fi
107}
108
109cell local >/dev/null # Default cell is the local VMs
110
111# Lists available cells
112function cells {
tom2482e6f2014-10-01 16:51:48 -0700113 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
Thomas Vachuska785f5812015-03-19 01:11:00 -0700114 printf "%-16s %s\n" \
tom2482e6f2014-10-01 16:51:48 -0700115 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
116 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
117 done
tomecd0fbd2014-09-19 08:47:05 -0700118}
tom5a18e802014-09-18 12:38:15 -0700119
tom5c255702014-09-18 06:57:39 -0700120# Miscellaneous
121function spy {
122 ps -ef | egrep "$@" | grep -v egrep
123}
124
125function nuke {
tom85258ee2014-10-07 00:10:02 -0700126 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700127}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800128
129# Edit a cell file by providing a cell name. Opens the cell file in $EDITOR.
130function vicell() {
131 local apply=false
132 local create=false
133 local cdf=""
134 local cpath="${ONOS_ROOT}/tools/test/cells/"
135
136 if [ -z "$1" ] || [ "$1" = "-h" ] ; then
137 printf "usage: vicell [file] [options]\n\noptions:\n"
138 printf "\t-a: apply the cell after editing\n"
139 printf "\t-e: [editor] set EDITOR to [editor] (default *vi*)\n"
140 printf "\t-c: create cell file if none exist\n\n"
141 return 1
142 fi
143
144 while [ $# -gt 0 ]; do
145 case "$1" in
146 -a) apply=true ;;
147 -e) EDITOR=$2; shift ;;
148 -c) create=true ;;
149 *) cdf="$1" ;;
150 esac
151 shift
152 done
153
154 if [ ! -e "${cpath}${cdf}" ] && [ "$create" = "false" ]; then
155 printf "${cdf} : no such cell\n" && return 1
156 fi
157
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800158 if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then
159 unset EDITOR && vi ${cpath}${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800160 else
161 $EDITOR ${cpath}${cdf}
162 fi
163 ($apply) && cell ${cdf}
Ayaka Koshibea9985132014-12-18 14:55:22 -0800164}
Ayaka Koshibeaec629622015-01-05 20:33:29 -0800165
166# autocomplete for certain utilities
167. ${ONOS_ROOT}/tools/test/bin/ogroup-opts