blob: a17ae2a7dbe33bb84554b8a3da04273d782be93a [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
pankajdff24442014-09-30 15:12:45 -07009export JAVA_HOME=$(/usr/libexec/java_home -v 1.7)
tom6a9f2722014-09-13 17:00:02 -070010export MAVEN=${MAVEN:-~/Applications/apache-maven-3.2.2}
11export KARAF=${KARAF:-~/Applications/apache-karaf-3.0.1}
12export KARAF_LOG=$KARAF/data/log/karaf.log
13
14# Setup a path
tom1cd74ae2014-10-01 14:58:32 -070015export PATH="$PATH:$ONOS_ROOT/tools/dev/bin:$ONOS_ROOT/tools/test/bin"
16export PATH="$PATH:$ONOS_ROOT/tools/build"
tom6a9f2722014-09-13 17:00:02 -070017export PATH="$PATH:$MAVEN/bin:$KARAF/bin"
18export PATH="$PATH:."
19
20# Convenience utility to warp to various ONOS source projects
21# e.g. 'o api', 'o dev', 'o'
22function o {
pankajdff24442014-09-30 15:12:45 -070023 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target' | \
tom9a693fd2014-10-03 11:32:19 -070024 egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1)
tom6a9f2722014-09-13 17:00:02 -070025}
26
27# Short-hand for 'mvn clean install' for us lazy folk
28alias mci='mvn clean install'
29
tom82d6bde2014-09-23 17:33:58 -070030# Short-hand for ONOS build, package and test.
31alias ob='onos-build'
tom1cd74ae2014-10-01 14:58:32 -070032alias obs='onos-build-selective'
tom82d6bde2014-09-23 17:33:58 -070033alias op='onos-package'
tomcaf3bf72014-09-23 13:20:53 -070034alias ot='onos-test'
tom0511a522014-10-04 12:06:02 -070035alias ol='onos-log'
toma6897792014-10-08 22:21:05 -070036alias ow='onos-watch'
tome2555ff2014-10-07 18:47:58 -070037alias go='ob && ot && onos -w'
tomca8f6702014-10-07 09:28:53 -070038alias pub='onos-push-update-bundle'
tom6a9f2722014-09-13 17:00:02 -070039
40# Short-hand for tailing the ONOS (karaf) log
tom1cd74ae2014-10-01 14:58:32 -070041alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log'
tom6a9f2722014-09-13 17:00:02 -070042alias tlo='tl | grep --colour=always org.onlab'
43
44# Pretty-print JSON output
45alias pp='python -m json.tool'
46
47# Short-hand to launch API docs and sample topology viewer GUI
48alias docs='open $ONOS_ROOT/target/site/apidocs/index.html'
tom1a2908c2014-09-23 16:37:39 -070049alias gui='onos-gui'
tom5c255702014-09-18 06:57:39 -070050
51
tom5a18e802014-09-18 12:38:15 -070052# Test related conveniences
53
tom5a18e802014-09-18 12:38:15 -070054# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070055alias sshctl='onos-ssh'
56alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070057
tomecd0fbd2014-09-19 08:47:05 -070058# Applies the settings in the specified cell file or lists current cell definition
59# if no cell file is given.
60function cell {
61 if [ -n "$1" ]; then
62 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
63 echo "No such cell: $1" >&2 && return 1
tom2482e6f2014-10-01 16:51:48 -070064 unset OC1 OC2 OC3 OC4 OC5 OC6 OC7 OC8 OC9 OCN OCI
tomecd0fbd2014-09-19 08:47:05 -070065 . $ONOS_ROOT/tools/test/cells/$1
66 export OCI=$OC1
67 export ONOS_CELL=$1
68 cell
69 else
70 env | egrep "ONOS_CELL"
71 env | egrep "OCI"
72 env | egrep "OC[0-9]+" | sort
tom0872a172014-09-23 11:24:26 -070073 env | egrep "OCN"
tome797a5d2014-09-30 11:57:50 -070074 env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL'
tomecd0fbd2014-09-19 08:47:05 -070075 fi
76}
77
78cell local >/dev/null # Default cell is the local VMs
79
80# Lists available cells
81function cells {
tom2482e6f2014-10-01 16:51:48 -070082 for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do
83 printf "%-12s %s\n" \
84 "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \
85 "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)"
86 done
tomecd0fbd2014-09-19 08:47:05 -070087}
tom5a18e802014-09-18 12:38:15 -070088
tom5c255702014-09-18 06:57:39 -070089# Miscellaneous
90function spy {
91 ps -ef | egrep "$@" | grep -v egrep
92}
93
94function nuke {
tom85258ee2014-10-07 00:10:02 -070095 spy "$@" | cut -c7-11 | xargs kill
tom5c255702014-09-18 06:57:39 -070096}