-#!/usr/bin/env python2
+#!/usr/bin/env python3
-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2021 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:
As source of truth, TG node from the topology file is used.
"""
-import sys
import argparse
+import sys
import yaml
-from resources.libraries.python.ssh import exec_cmd
+from resources.libraries.python.ssh import exec_cmd as _exec_cmd
+
+RESERVATION_DIR = u"/tmp/reservation_dir"
+RESERVATION_NODE = u"TG"
-RESERVATION_DIR = "/tmp/reservation_dir"
+def exec_cmd(node, cmd):
+ """A wrapper around ssh.exec_cmd with disabled JSON export.
+
+ Using this, maintainers can use "exec_cmd" without worrying
+ about interaction with json export.
+
+ TODO: Instead this, divide ssh module into reusable and robot-bound parts.
+
+ :param node: Node object as parsed from topology file to execute cmd on.
+ :param cmd: Command to execute.
+ :type node: dict
+ :type cmd: str
+ :returns: RC, Stdout, Stderr.
+ :rtype: Tuple[int, str, str]
+ """
+ return _exec_cmd(node, cmd, export=False)
def diag_cmd(node, cmd):
"""Execute cmd, print cmd and stdout, ignore stderr and rc; return None.
:param node: Node object as parsed from topology file to execute cmd on.
:param cmd: Command to execute.
- :type ssh: dict
+ :type node: dict
:type cmd: str
"""
- print "+", cmd
+ print(f"+ {cmd}")
_, stdout, _ = exec_cmd(node, cmd)
- print stdout
+ print(stdout)
def main():
Python returns on encountering and unexcepted exception.
"""
parser = argparse.ArgumentParser()
- parser.add_argument("-t", "--topo", required=True,
- help="Topology file")
- parser.add_argument("-c", "--cancel", help="Cancel reservation",
- action="store_true")
- parser.add_argument("-r", "--runtag", required=False, default="Unknown",
- help="Identifier for test run suitable as filename")
+ parser.add_argument(u"-t", u"--topo", required=True, help=u"Topology file")
+ parser.add_argument(
+ u"-c", u"--cancel", help=u"Cancel reservation", action=u"store_true"
+ )
+ parser.add_argument(
+ u"-r", u"--runtag", required=False, default=u"Unknown",
+ help=u"Identifier for test run suitable as filename"
+ )
args = parser.parse_args()
- with open(args.topo, "r") as topo_file:
- topology = yaml.load(topo_file.read())['nodes']
+ with open(args.topo, u"rt") as topo_file:
+ topology = yaml.safe_load(topo_file.read())[u"nodes"]
# Even if TG is not guaranteed to be a Linux host,
# we are using it, because testing shows SSH access to DUT
# during test affects its performance (bursts of lost packets).
try:
- tgn = topology["TG"]
+ node = topology[RESERVATION_NODE]
except KeyError:
- print "Topology file does not contain 'TG' node"
+ print(f"Topology file does not contain '{RESERVATION_NODE}' node")
return 1
# For system reservation we use mkdir it is an atomic operation and we can
# store additional data (time, client_ID, ..) within reservation directory.
if args.cancel:
- ret, _, err = exec_cmd(tgn, "rm -r {}".format(RESERVATION_DIR))
- if ret:
- print "Cancellation unsuccessful:\n{}".format(err)
- return ret
+ ret, _, err = exec_cmd(node, f"rm -r {RESERVATION_DIR}")
+ # If connection is refused, ret==None.
+ if ret != 0:
+ print(f"Cancellation unsuccessful:\n{err!r}")
+ return 1
+ return 0
# Before critical section, output can be outdated already.
- print("Diagnostic commands:")
- # -d and * are to supress "total <size>", see https://askubuntu.com/a/61190
- diag_cmd(tgn, "ls --full-time -cd '{dir}'/*".format(dir=RESERVATION_DIR))
- print("Attempting reservation.")
+ print(u"Diagnostic commands:")
+ # -d and * are to suppress "total <size>", see https://askubuntu.com/a/61190
+ diag_cmd(node, f"ls --full-time -cd '{RESERVATION_DIR}'/*")
+ print(u"Attempting testbed reservation.")
# Entering critical section.
- ret, _, err = exec_cmd(tgn, "mkdir '{dir}'".format(dir=RESERVATION_DIR))
+ ret, _, _ = exec_cmd(node, f"mkdir '{RESERVATION_DIR}'")
# Critical section is over.
- if ret:
- print("Already reserved by another job:\n{}".format(err))
+ if ret is None:
+ print(u"Failed to connect to testbed.")
+ return 1
+ if ret != 0:
+ _, stdo, _ = exec_cmd(node, f"ls '{RESERVATION_DIR}'/*")
+ print(f"Testbed already reserved by:\n{stdo}")
return 2
# Here the script knows it is the only owner of the testbed.
- print("Success, writing test run info to reservation dir.")
- ret2, _, err = exec_cmd(
- tgn, "touch '{dir}/{runtag}'"\
- .format(dir=RESERVATION_DIR, runtag=args.runtag))
- if ret2:
- print("Writing test run info failed, but continuing anyway:\n{}".format(
- err))
+ print(u"Reservation success, writing additional info to reservation dir.")
+ ret, _, err = exec_cmd(
+ node, f"touch '{RESERVATION_DIR}/{args.runtag}'")
+ if ret != 0:
+ print(f"Writing test run info failed, but continuing anyway:\n{err!r}")
return 0
-if __name__ == "__main__":
+if __name__ == u"__main__":
sys.exit(main())