Lab reservation tool

This tool provide client-based reservation system of tesbeds
by using existing topology files.

Change-Id: Ic0be944c77c9d6aa28e3fa7fa69e31d19861416f
Signed-off-by: Miroslav Miklus <mmiklus@cisco.com>

2 files changed, 117 insertions, 2 deletions

diff --git a/bootstrap-hw-tb2.sh b/bootstrap-hw-tb2.sh
index bb5afcaac3..1b889b3039 100755
--- a/bootstrap-hw-tb2.sh
+++ b/bootstrap-hw-tb2.sh
@@ -1,7 +1,26 @@
 #!/bin/bash
+# Copyright (c) 2016 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 set -x
 
+# space separated list of available testbeds, described by topology files
+TOPOLOGIES="topologies/available/lf_testbed2-710-520.yaml"
+
+CUR_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+WORKING_TOPOLOGY=""
+export PYTHONPATH=${CUR_DIR}
+
 sudo apt-get -y update
 sudo apt-get -y install libpython2.7-dev python-virtualenv
 
@@ -11,6 +30,37 @@ virtualenv env
 echo pip install
 pip install -r requirements.txt
 
-PYTHONPATH=`pwd` pybot -L TRACE \
-    -v TOPOLOGY_PATH:topologies/available/lf_testbed2-710-520.yaml \
+#we iterate over available topologies and wait until we reserve topology
+while :; do
+    for TOPOLOGY in ${TOPOLOGIES};
+    do
+        python ${CUR_DIR}/resources/tools/topo_reservation.py -t ${TOPOLOGY}
+        if [ $? -eq 0 ]; then
+            WORKING_TOPOLOGY=${TOPOLOGY}
+            echo "Reserved: ${WORKING_TOPOLOGY}"
+            break
+        fi
+    done
+
+    if [ ! -z "${WORKING_TOPOLOGY}" ]; then
+        #exit the infinite while loop if we made a reservation
+        break
+    fi
+
+    #wait 10 - 30 sec. before next try
+    SLEEP_TIME=$[ ( $RANDOM % 20 ) + 10 ]s
+    echo "Sleeping ${SLEEP_TIME}"
+    sleep ${SLEEP_TIME}
+done
+
+function cancel_reservation {
+    python ${CUR_DIR}/resources/tools/topo_reservation.py -c -t $1
+}
+
+#on script exit we cancel the reservation
+trap "cancel_reservation ${WORKING_TOPOLOGY}" EXIT
+
+#run performance test suite
+pybot -L TRACE \
+    -v TOPOLOGY_PATH:${WORKING_TOPOLOGY} \
     -s performance tests/
diff --git a/resources/tools/topo_reservation.py b/resources/tools/topo_reservation.py
new file mode 100644
index 0000000000..4b5ed2459c
--- /dev/null
+++ b/resources/tools/topo_reservation.py
@@ -0,0 +1,65 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2016 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This script provides simple reservation mechanism to avoid
+   simultaneous use of nodes listed in topology file.
+   As source of truth is used DUT1 node from the topology file."""
+
+import sys
+import argparse
+from resources.libraries.python.ssh import SSH
+from yaml import load
+
+RESERVATION_DIR = "/tmp/reservation_dir"
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-t", "--topo", required=True,
+                        help="Topology file")
+    parser.add_argument("-c", "--cancel", help="Cancel reservation",
+                        action="store_true")
+    args = parser.parse_args()
+    topology_file = args.topo
+    cancel_reservation = args.cancel
+
+    work_file = open(topology_file)
+    topology = load(work_file.read())['nodes']
+
+    #we are using DUT1 node because we expect DUT1 to be a linux host
+    #we don't use TG because we don't expect TG to be linux only host
+    try:
+        tg_node = topology["DUT1"]
+    except KeyError:
+        print "Topology file does not contain 'DUT1' node"
+        return 1
+
+    ssh = SSH()
+    ssh.connect(tg_node)
+
+    #For system reservation we use mkdir it is an atomic operation and we can
+    #store additional data (time, client_ID, ..) within reservation directory
+    if cancel_reservation:
+        ret, _, err = ssh.exec_command("rm -r {}".format(RESERVATION_DIR))
+    else:
+        ret, _, err = ssh.exec_command("mkdir {}".format(RESERVATION_DIR))
+
+    if ret != 0:
+        print("{} unsuccessful:\n{}".
+              format(("Cancellation " if cancel_reservation else "Reservation"),
+                     err))
+    return ret
+
+if __name__ == "__main__":
+    sys.exit(main())