blob: 8d4a784f608b464940c88afe9ee49c8c7688e71d [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
6export ONOS_ROOT=${ONOS_ROOT:-~/onos-next}
7
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
11 export JAVA_HOME=$(/usr/libexec/java_home -v 1.7)
12 elif [ -d /usr/lib/jvm/java-7-openjdk-amd64 ]; then
13 export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"
14 fi
15fi
tom6a9f2722014-09-13 17:00:02 -070016export MAVEN=${MAVEN:-~/Applications/apache-maven-3.2.2}
17export KARAF=${KARAF:-~/Applications/apache-karaf-3.0.1}
18export KARAF_LOG=$KARAF/data/log/karaf.log
19
20# Setup a path
tom1cd74ae2014-10-01 14:58:32 -070021export PATH="$PATH:$ONOS_ROOT/tools/dev/bin:$ONOS_ROOT/tools/test/bin"
22export PATH="$PATH:$ONOS_ROOT/tools/build"
tom6a9f2722014-09-13 17:00:02 -070023export PATH="$PATH:$MAVEN/bin:$KARAF/bin"
tom6a9f2722014-09-13 17:00:02 -070024
25# Convenience utility to warp to various ONOS source projects
26# e.g. 'o api', 'o dev', 'o'
27function o {
tomcf8dd2a2014-10-10 08:37:20 -070028 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|gen-src' | \
tom9a693fd2014-10-03 11:32:19 -070029 egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070030}
31
32# Short-hand for 'mvn clean install' for us lazy folk
33alias mci='mvn clean install'
34
tom82d6bde2014-09-23 17:33:58 -070035# Short-hand for ONOS build, package and test.
36alias ob='onos-build'
tom1cd74ae2014-10-01 14:58:32 -070037alias obs='onos-build-selective'
tom82d6bde2014-09-23 17:33:58 -070038alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070039alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070040alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070041alias ow='onos-watch'
tome2555ff2014-10-07 18:47:58 -070042alias go='ob && ot && onos -w'
tomca8f6702014-10-07 09:28:53 -070043alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070044
45# Short-hand for tailing the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070046alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
tom6a9f2722014-09-13 17:00:02 -070047alias tlo='tl | grep --colour=always org.onlab'
Jonathan Hartd57df6c2014-10-17 15:18:02 -070048alias ll='less $KARAF_LOG'
tom6a9f2722014-09-13 17:00:02 -070049
50# Pretty-print JSON output
51alias pp='python -m json.tool'
52
53# Short-hand to launch API docs and sample topology viewer GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070054alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
tom1a2908c2014-09-23 16:37:39 -070055alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070056
57
tom5a18e802014-09-18 12:38:15 -070058# Test related conveniences
59
tom5a18e802014-09-18 12:38:15 -070060# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070061alias sshctl='onos-ssh'
62alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070063
tomecd0fbd2014-09-19 08:47:05 -070064# Applies the settings in the specified cell file or lists current cell definition
65# if no cell file is given.
66function cell {
67 if [ -n "$1" ]; then
68 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
69 echo "No such cell: $1" >&2 && return 1
Pavlin Radoslavov0770d0f2014-10-15 15:58:31 -070070 unset ONOS_CELL ONOS_NIC ONOS_FEATURES
Pavlin Radoslavov711145a2014-10-16 17:45:48 -070071 unset OC0 OC1 OC2 OC3 OC4 OC5 OC6 OC7 OC8 OC9 OCN OCI
Thomas Vachuskacce11ca2014-10-16 11:52:29 -070072 export ONOS_CELL=$1
tomecd0fbd2014-09-19 08:47:05 -070073 . $ONOS_ROOT/tools/test/cells/$1
tomecd0fbd2014-09-19 08:47:05 -070074 cell
75 else
76 env | egrep "ONOS_CELL"
77 env | egrep "OCI"
Pavlin Radoslavov711145a2014-10-16 17:45:48 -070078 env | egrep "OC[0-9]+" | sort
tom0872a172014-09-23 11:24:26 -070079 env | egrep "OCN"
tome797a5d2014-09-30 11:57:50 -070080 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL'
tomecd0fbd2014-09-19 08:47:05 -070081 fi
82}
83
84cell local >/dev/null # Default cell is the local VMs
85
86# Lists available cells
87function cells {
tom2482e6f2014-10-01 16:51:48 -070088 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
89 printf "%-12s %s\n" \
90 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
91 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
92 done
tomecd0fbd2014-09-19 08:47:05 -070093}
tom5a18e802014-09-18 12:38:15 -070094
tom5c255702014-09-18 06:57:39 -070095# Miscellaneous
96function spy {
97 ps -ef | egrep "$@" | grep -v egrep
98}
99
100function nuke {
tom85258ee2014-10-07 00:10:02 -0700101 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700102}