tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 1 | #!/bin/bash |
| 2 | # ONOS developer BASH profile conveniences |
tom | 5a18e80 | 2014-09-18 12:38:15 -0700 | [diff] [blame] | 3 | # Simply include in your own .bash_aliases or .bash_profile |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 4 | |
| 5 | # Root of the ONOS source tree |
Thomas Vachuska | 045c01d | 2014-12-04 00:18:06 -0800 | [diff] [blame] | 6 | export ONOS_ROOT=${ONOS_ROOT:-~/onos} |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 7 | |
| 8 | # Setup some environmental context for developers |
Pavlin Radoslavov | 9361721 | 2014-10-16 09:54:04 -0700 | [diff] [blame] | 9 | if [ -z "${JAVA_HOME}" ]; then |
| 10 | if [ -x /usr/libexec/java_home ]; then |
Thomas Vachuska | d853115 | 2014-11-03 14:39:57 -0800 | [diff] [blame] | 11 | export JAVA_HOME=$(/usr/libexec/java_home -v 1.8) |
| 12 | elif [ -d /usr/lib/jvm/java-8-oracle ]; then |
| 13 | export JAVA_HOME="/usr/lib/jvm/java-8-oracle" |
Pavlin Radoslavov | 9361721 | 2014-10-16 09:54:04 -0700 | [diff] [blame] | 14 | elif [ -d /usr/lib/jvm/java-7-openjdk-amd64 ]; then |
| 15 | export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64" |
| 16 | fi |
| 17 | fi |
Thomas Vachuska | 7b652ad | 2014-10-30 14:10:51 -0700 | [diff] [blame] | 18 | |
Charles M.C. Chan | b8b96c1 | 2014-12-08 19:33:51 -0800 | [diff] [blame] | 19 | export MAVEN=${MAVEN:-~/Applications/apache-maven-3.2.3} |
Thomas Vachuska | 7b652ad | 2014-10-30 14:10:51 -0700 | [diff] [blame] | 20 | |
Thomas Vachuska | d853115 | 2014-11-03 14:39:57 -0800 | [diff] [blame] | 21 | export KARAF_VERSION=${KARAF_VERSION:-3.0.2} |
Thomas Vachuska | 255b65f | 2014-11-23 14:25:31 -0800 | [diff] [blame] | 22 | export KARAF_ROOT=${KARAF_ROOT:-~/Applications/apache-karaf-$KARAF_VERSION} |
| 23 | export KARAF_LOG=$KARAF_ROOT/data/log/karaf.log |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 24 | |
| 25 | # Setup a path |
tom | 1cd74ae | 2014-10-01 14:58:32 -0700 | [diff] [blame] | 26 | export PATH="$PATH:$ONOS_ROOT/tools/dev/bin:$ONOS_ROOT/tools/test/bin" |
| 27 | export PATH="$PATH:$ONOS_ROOT/tools/build" |
Thomas Vachuska | 255b65f | 2014-11-23 14:25:31 -0800 | [diff] [blame] | 28 | export PATH="$PATH:$MAVEN/bin:$KARAF_ROOT/bin" |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 29 | |
| 30 | # Convenience utility to warp to various ONOS source projects |
| 31 | # e.g. 'o api', 'o dev', 'o' |
| 32 | function o { |
tom | cf8dd2a | 2014-10-10 08:37:20 -0700 | [diff] [blame] | 33 | cd $(find $ONOS_ROOT/ -type d | egrep -v '\.git|target|gen-src' | \ |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 34 | egrep "${1:-$ONOS_ROOT}" | egrep -v "$ONOS_ROOT/.+/src/" | head -n 1) |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 35 | } |
| 36 | |
| 37 | # Short-hand for 'mvn clean install' for us lazy folk |
| 38 | alias mci='mvn clean install' |
Yuta HIGUCHI | 007cdff | 2014-11-20 13:39:05 -0800 | [diff] [blame] | 39 | alias mcis='mvn clean install -DskipTests -Dcheckstyle.skip -U -T 1C' |
| 40 | alias mis='mvn install -DskipTests -Dcheckstyle.skip -U -T 1C' |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 41 | |
tom | 82d6bde | 2014-09-23 17:33:58 -0700 | [diff] [blame] | 42 | # Short-hand for ONOS build, package and test. |
| 43 | alias ob='onos-build' |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 44 | alias obi='onos-build -Dmaven.test.failure.ignore=true' |
tom | 1cd74ae | 2014-10-01 14:58:32 -0700 | [diff] [blame] | 45 | alias obs='onos-build-selective' |
Thomas Vachuska | 7cbfd4f | 2014-11-04 18:22:49 -0800 | [diff] [blame] | 46 | alias obd='onos-build-docs' |
tom | 82d6bde | 2014-09-23 17:33:58 -0700 | [diff] [blame] | 47 | alias op='onos-package' |
tom | caf3bf7 | 2014-09-23 13:20:53 -0700 | [diff] [blame] | 48 | alias ot='onos-test' |
tom | 0511a52 | 2014-10-04 12:06:02 -0700 | [diff] [blame] | 49 | alias ol='onos-log' |
tom | a689779 | 2014-10-08 22:21:05 -0700 | [diff] [blame] | 50 | alias ow='onos-watch' |
Thomas Vachuska | 8531429 | 2014-11-14 17:52:12 -0800 | [diff] [blame] | 51 | alias oi='setPrimaryInstance' |
Sho SHIMIZU | c02c0b8 | 2014-12-12 10:25:24 -0800 | [diff] [blame] | 52 | # alias go='ob && ot && onos -w' |
tom | ca8f670 | 2014-10-07 09:28:53 -0700 | [diff] [blame] | 53 | alias pub='onos-push-update-bundle' |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 54 | |
| 55 | # Short-hand for tailing the ONOS (karaf) log |
tom | 1cd74ae | 2014-10-01 14:58:32 -0700 | [diff] [blame] | 56 | alias tl='$ONOS_ROOT/tools/dev/bin/onos-local-log' |
Thomas Vachuska | bbea58c | 2014-12-02 22:50:10 -0800 | [diff] [blame] | 57 | alias tlo='tl | grep --colour=always -E -e "org.onlab|org.onosproject"' |
Jonathan Hart | d57df6c | 2014-10-17 15:18:02 -0700 | [diff] [blame] | 58 | alias ll='less $KARAF_LOG' |
tom | 6a9f272 | 2014-09-13 17:00:02 -0700 | [diff] [blame] | 59 | |
| 60 | # Pretty-print JSON output |
| 61 | alias pp='python -m json.tool' |
| 62 | |
| 63 | # Short-hand to launch API docs and sample topology viewer GUI |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 64 | alias docs='open $ONOS_ROOT/docs/target/site/apidocs/index.html' |
tom | 1a2908c | 2014-09-23 16:37:39 -0700 | [diff] [blame] | 65 | alias gui='onos-gui' |
tom | 5c25570 | 2014-09-18 06:57:39 -0700 | [diff] [blame] | 66 | |
| 67 | |
tom | 5a18e80 | 2014-09-18 12:38:15 -0700 | [diff] [blame] | 68 | # Test related conveniences |
| 69 | |
tom | 5a18e80 | 2014-09-18 12:38:15 -0700 | [diff] [blame] | 70 | # SSH to a specified ONOS instance |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 71 | alias sshctl='onos-ssh' |
| 72 | alias sshnet='onos-ssh $OCN' |
tom | 5a18e80 | 2014-09-18 12:38:15 -0700 | [diff] [blame] | 73 | |
tom | ecd0fbd | 2014-09-19 08:47:05 -0700 | [diff] [blame] | 74 | # Applies the settings in the specified cell file or lists current cell definition |
| 75 | # if no cell file is given. |
| 76 | function cell { |
| 77 | if [ -n "$1" ]; then |
| 78 | [ ! -f $ONOS_ROOT/tools/test/cells/$1 ] && \ |
| 79 | echo "No such cell: $1" >&2 && return 1 |
Charles M.C. Chan | dfbc6d8 | 2014-12-18 23:11:36 +0800 | [diff] [blame] | 80 | unset ONOS_CELL ONOS_NIC ONOS_FEATURES ONOS_USER ONOS_GROUP |
Ayaka Koshibe | ebb5444 | 2015-01-09 14:22:19 -0800 | [diff] [blame] | 81 | unset OCI OCN |
| 82 | unset $(env | sed -n 's:\(^OC[0-9]\{1,\}\)=.*:\1 :g p') |
Thomas Vachuska | cce11ca | 2014-10-16 11:52:29 -0700 | [diff] [blame] | 83 | export ONOS_CELL=$1 |
tom | ecd0fbd | 2014-09-19 08:47:05 -0700 | [diff] [blame] | 84 | . $ONOS_ROOT/tools/test/cells/$1 |
tom | ecd0fbd | 2014-09-19 08:47:05 -0700 | [diff] [blame] | 85 | cell |
| 86 | else |
| 87 | env | egrep "ONOS_CELL" |
| 88 | env | egrep "OCI" |
Pavlin Radoslavov | 711145a | 2014-10-16 17:45:48 -0700 | [diff] [blame] | 89 | env | egrep "OC[0-9]+" | sort |
tom | 0872a17 | 2014-09-23 11:24:26 -0700 | [diff] [blame] | 90 | env | egrep "OCN" |
tom | e797a5d | 2014-09-30 11:57:50 -0700 | [diff] [blame] | 91 | env | egrep "ONOS_" | egrep -v 'ONOS_ROOT|ONOS_CELL' |
tom | ecd0fbd | 2014-09-19 08:47:05 -0700 | [diff] [blame] | 92 | fi |
| 93 | } |
| 94 | |
| 95 | cell local >/dev/null # Default cell is the local VMs |
| 96 | |
| 97 | # Lists available cells |
| 98 | function cells { |
tom | 2482e6f | 2014-10-01 16:51:48 -0700 | [diff] [blame] | 99 | for cell in $(ls -1 $ONOS_ROOT/tools/test/cells); do |
| 100 | printf "%-12s %s\n" \ |
| 101 | "$([ $cell = $ONOS_CELL ] && echo $cell '*' || echo $cell)" \ |
| 102 | "$(grep '^#' $ONOS_ROOT/tools/test/cells/$cell | head -n 1)" |
| 103 | done |
tom | ecd0fbd | 2014-09-19 08:47:05 -0700 | [diff] [blame] | 104 | } |
tom | 5a18e80 | 2014-09-18 12:38:15 -0700 | [diff] [blame] | 105 | |
Thomas Vachuska | 8531429 | 2014-11-14 17:52:12 -0800 | [diff] [blame] | 106 | # Sets the primary instance to the specified instance number. |
| 107 | function setPrimaryInstance { |
| 108 | export OCI=$(env | egrep "OC[0-9]+" | sort | egrep OC${1:-1} | cut -d= -f2) |
| 109 | echo $OCI |
| 110 | } |
| 111 | |
tom | 5c25570 | 2014-09-18 06:57:39 -0700 | [diff] [blame] | 112 | # Miscellaneous |
| 113 | function spy { |
| 114 | ps -ef | egrep "$@" | grep -v egrep |
| 115 | } |
| 116 | |
| 117 | function nuke { |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 118 | spy "$@" | cut -c7-11 | xargs kill |
tom | 5c25570 | 2014-09-18 06:57:39 -0700 | [diff] [blame] | 119 | } |
Ayaka Koshibe | a998513 | 2014-12-18 14:55:22 -0800 | [diff] [blame] | 120 | |
| 121 | # Edit a cell file by providing a cell name. Opens the cell file in $EDITOR. |
| 122 | function vicell() { |
| 123 | local apply=false |
| 124 | local create=false |
| 125 | local cdf="" |
| 126 | local cpath="${ONOS_ROOT}/tools/test/cells/" |
| 127 | |
| 128 | if [ -z "$1" ] || [ "$1" = "-h" ] ; then |
| 129 | printf "usage: vicell [file] [options]\n\noptions:\n" |
| 130 | printf "\t-a: apply the cell after editing\n" |
| 131 | printf "\t-e: [editor] set EDITOR to [editor] (default *vi*)\n" |
| 132 | printf "\t-c: create cell file if none exist\n\n" |
| 133 | return 1 |
| 134 | fi |
| 135 | |
| 136 | while [ $# -gt 0 ]; do |
| 137 | case "$1" in |
| 138 | -a) apply=true ;; |
| 139 | -e) EDITOR=$2; shift ;; |
| 140 | -c) create=true ;; |
| 141 | *) cdf="$1" ;; |
| 142 | esac |
| 143 | shift |
| 144 | done |
| 145 | |
| 146 | if [ ! -e "${cpath}${cdf}" ] && [ "$create" = "false" ]; then |
| 147 | printf "${cdf} : no such cell\n" && return 1 |
| 148 | fi |
| 149 | |
Ayaka Koshibe | aec62962 | 2015-01-05 20:33:29 -0800 | [diff] [blame] | 150 | if [ -z "${EDITOR}" ] || [ -x "$(which ${EDITOR})" ]; then |
| 151 | unset EDITOR && vi ${cpath}${cdf} |
Ayaka Koshibe | a998513 | 2014-12-18 14:55:22 -0800 | [diff] [blame] | 152 | else |
| 153 | $EDITOR ${cpath}${cdf} |
| 154 | fi |
| 155 | ($apply) && cell ${cdf} |
Ayaka Koshibe | a998513 | 2014-12-18 14:55:22 -0800 | [diff] [blame] | 156 | } |
Ayaka Koshibe | aec62962 | 2015-01-05 20:33:29 -0800 | [diff] [blame] | 157 | |
| 158 | # autocomplete for certain utilities |
| 159 | . ${ONOS_ROOT}/tools/test/bin/ogroup-opts |