blob: 1a0c93f4c95a313e3ddf542429d3765e3c056cbf [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
Madan Jampani6677edb2014-10-29 15:45:55 -070011 export JAVA_HOME=$(/usr/libexec/java_home -v 1.7)
Pavlin Radoslavov93617212014-10-16 09:54:04 -070012 elif [ -d /usr/lib/jvm/java-7-openjdk-amd64 ]; then
13 export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"
14 fi
15fi
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070016
tom6a9f2722014-09-13 17:00:02 -070017export MAVEN=${MAVEN:-~/Applications/apache-maven-3.2.2}
Thomas Vachuska7b652ad2014-10-30 14:10:51 -070018
19export KARAF_VERSION=${KARAF_VERSION:-3.0.1}
20export KARAF=${KARAF:-~/Applications/apache-karaf-$KARAF_VERSION}
tom6a9f2722014-09-13 17:00:02 -070021export KARAF_LOG=$KARAF/data/log/karaf.log
22
23# Setup a path
tom1cd74ae2014-10-01 14:58:32 -070024export PATH="$PATH:$ONOS_ROOT/tools/dev/bin:$ONOS_ROOT/tools/test/bin"
25export PATH="$PATH:$ONOS_ROOT/tools/build"
tom6a9f2722014-09-13 17:00:02 -070026export PATH="$PATH:$MAVEN/bin:$KARAF/bin"
tom6a9f2722014-09-13 17:00:02 -070027
28# Convenience utility to warp to various ONOS source projects
29# e.g. 'o api', 'o dev', 'o'
30function o {
tomcf8dd2a2014-10-10 08:37:20 -070031 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|gen-src' | \
tom9a693fd2014-10-03 11:32:19 -070032 egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070033}
34
35# Short-hand for 'mvn clean install' for us lazy folk
36alias mci='mvn clean install'
37
tom82d6bde2014-09-23 17:33:58 -070038# Short-hand for ONOS build, package and test.
39alias ob='onos-build'
Thomas Vachuskad16ce182014-10-29 17:25:29 -070040alias obi='onos-build -Dmaven.test.failure.ignore=true'
tom1cd74ae2014-10-01 14:58:32 -070041alias obs='onos-build-selective'
tom82d6bde2014-09-23 17:33:58 -070042alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070043alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070044alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070045alias ow='onos-watch'
tome2555ff2014-10-07 18:47:58 -070046alias go='ob && ot && onos -w'
tomca8f6702014-10-07 09:28:53 -070047alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070048
49# Short-hand for tailing the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070050alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
tom6a9f2722014-09-13 17:00:02 -070051alias tlo='tl | grep --colour=always org.onlab'
Jonathan Hartd57df6c2014-10-17 15:18:02 -070052alias ll='less $KARAF_LOG'
tom6a9f2722014-09-13 17:00:02 -070053
54# Pretty-print JSON output
55alias pp='python -m json.tool'
56
57# Short-hand to launch API docs and sample topology viewer GUI
Thomas Vachuska24c849c2014-10-27 09:53:05 -070058alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html'
tom1a2908c2014-09-23 16:37:39 -070059alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070060
61
tom5a18e802014-09-18 12:38:15 -070062# Test related conveniences
63
tom5a18e802014-09-18 12:38:15 -070064# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070065alias sshctl='onos-ssh'
66alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070067
tomecd0fbd2014-09-19 08:47:05 -070068# Applies the settings in the specified cell file or lists current cell definition
69# if no cell file is given.
70function cell {
71 if [ -n "$1" ]; then
72 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
73 echo "No such cell: $1" >&2 && return 1
Pavlin Radoslavov0770d0f2014-10-15 15:58:31 -070074 unset ONOS_CELL ONOS_NIC ONOS_FEATURES
Pavlin Radoslavov711145a2014-10-16 17:45:48 -070075 unset OC0 OC1 OC2 OC3 OC4 OC5 OC6 OC7 OC8 OC9 OCN OCI
Thomas Vachuskacce11ca2014-10-16 11:52:29 -070076 export ONOS_CELL=$1
tomecd0fbd2014-09-19 08:47:05 -070077 . $ONOS_ROOT/tools/test/cells/$1
tomecd0fbd2014-09-19 08:47:05 -070078 cell
79 else
80 env | egrep "ONOS_CELL"
81 env | egrep "OCI"
Pavlin Radoslavov711145a2014-10-16 17:45:48 -070082 env | egrep "OC[0-9]+" | sort
tom0872a172014-09-23 11:24:26 -070083 env | egrep "OCN"
tome797a5d2014-09-30 11:57:50 -070084 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL'
tomecd0fbd2014-09-19 08:47:05 -070085 fi
86}
87
88cell local >/dev/null # Default cell is the local VMs
89
90# Lists available cells
91function cells {
tom2482e6f2014-10-01 16:51:48 -070092 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
93 printf "%-12s %s\n" \
94 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
95 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
96 done
tomecd0fbd2014-09-19 08:47:05 -070097}
tom5a18e802014-09-18 12:38:15 -070098
tom5c255702014-09-18 06:57:39 -070099# Miscellaneous
100function spy {
101 ps -ef | egrep "$@" | grep -v egrep
102}
103
104function nuke {
tom85258ee2014-10-07 00:10:02 -0700105 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -0700106}