blob: f6c427a76429527ae71f6a861aca34a745a4ecc6 [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
9export JAVA_HOME=$(/usr/libexec/java_home)
10export 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
15export PS=":"
tom5c255702014-09-18 06:57:39 -070016export PATH="$PATH:$ONOS_ROOT/tools/dev:$ONOS_ROOT/tools/build"
17export PATH="$PATH:$ONOS_ROOT/tools/test/bin"
tom6a9f2722014-09-13 17:00:02 -070018export PATH="$PATH:$MAVEN/bin:$KARAF/bin"
19export PATH="$PATH:."
20
21# Convenience utility to warp to various ONOS source projects
22# e.g. 'o api', 'o dev', 'o'
23function o {
24 cd $(find $ONOS_ROOT/ -type d | egrep -v '.git|target|src' | \
25 egrep "${1:-$ONOS_ROOT}" | head -n 1)
26}
27
28# Short-hand for 'mvn clean install' for us lazy folk
29alias mci='mvn clean install'
30
31# Short-hand for ONOS build from the top of the source tree.
32alias ob='o && mvn clean install javadoc:aggregate'
33
34# Short-hand for tailing the ONOS (karaf) log
35alias tl='$ONOS_ROOT/tools/dev/watchLog'
36alias tlo='tl | grep --colour=always org.onlab'
37
38# Pretty-print JSON output
39alias pp='python -m json.tool'
40
41# Short-hand to launch API docs and sample topology viewer GUI
42alias docs='open $ONOS_ROOT/target/site/apidocs/index.html'
43alias gui='open http://localhost:8181/onos/tvue'
tom5c255702014-09-18 06:57:39 -070044
45
tom5a18e802014-09-18 12:38:15 -070046# Test related conveniences
47
tom5a18e802014-09-18 12:38:15 -070048# SSH to a specified ONOS instance
49function sshctl {
50 [ -n "$1" ] && OCI=$1 && shift
51 ssh -Y sdn@$OCI "$@"
52}
53
tomecd0fbd2014-09-19 08:47:05 -070054# Applies the settings in the specified cell file or lists current cell definition
55# if no cell file is given.
56function cell {
57 if [ -n "$1" ]; then
58 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
59 echo "No such cell: $1" >&2 && return 1
60 . $ONOS_ROOT/tools/test/cells/$1
61 export OCI=$OC1
62 export ONOS_CELL=$1
63 cell
64 else
65 env | egrep "ONOS_CELL"
66 env | egrep "OCI"
67 env | egrep "OC[0-9]+" | sort
68 fi
69}
70
71cell local >/dev/null # Default cell is the local VMs
72
73# Lists available cells
74function cells {
75 ls -1 $ONOS_ROOT/tools/test/cells
76}
tom5a18e802014-09-18 12:38:15 -070077
tom5c255702014-09-18 06:57:39 -070078# Miscellaneous
79function spy {
80 ps -ef | egrep "$@" | grep -v egrep
81}
82
83function nuke {
84 spy | cut -c7-11 | xargs kill
85}