blob: 328f5f438a4b7df1289ae30e51a59e7879b86e7a [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 {
Yuta HIGUCHIf2d83cf2014-09-19 14:29:54 -070024 cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|src' | \
tom6a9f2722014-09-13 17:00:02 -070025 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'
tomcaf3bf72014-09-23 13:20:53 -070033alias ot='onos-test'
tom6a9f2722014-09-13 17:00:02 -070034
35# Short-hand for tailing the ONOS (karaf) log
36alias tl='$ONOS_ROOT/tools/dev/watchLog'
37alias tlo='tl | grep --colour=always org.onlab'
38
39# Pretty-print JSON output
40alias pp='python -m json.tool'
41
42# Short-hand to launch API docs and sample topology viewer GUI
43alias docs='open $ONOS_ROOT/target/site/apidocs/index.html'
44alias gui='open http://localhost:8181/onos/tvue'
tom5c255702014-09-18 06:57:39 -070045
46
tom5a18e802014-09-18 12:38:15 -070047# Test related conveniences
48
tom5a18e802014-09-18 12:38:15 -070049# SSH to a specified ONOS instance
tom0872a172014-09-23 11:24:26 -070050alias sshctl='onos-ssh'
51alias sshnet='onos-ssh $OCN'
tom5a18e802014-09-18 12:38:15 -070052
tomecd0fbd2014-09-19 08:47:05 -070053# Applies the settings in the specified cell file or lists current cell definition
54# if no cell file is given.
55function cell {
56 if [ -n "$1" ]; then
57 [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \
58 echo "No such cell: $1" >&2 && return 1
59 . $ONOS_ROOT/tools/test/cells/$1
60 export OCI=$OC1
61 export ONOS_CELL=$1
62 cell
63 else
64 env | egrep "ONOS_CELL"
65 env | egrep "OCI"
66 env | egrep "OC[0-9]+" | sort
tom0872a172014-09-23 11:24:26 -070067 env | egrep "OCN"
tomecd0fbd2014-09-19 08:47:05 -070068 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}