2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
22 ResourceState, reschedule_delay
23 from nepi.resources.linux import rpmfuncs, debfuncs
24 from nepi.util import sshfuncs, execfuncs
25 from nepi.util.sshfuncs import ProcStatus
36 # TODO: Unify delays!!
37 # TODO: Validate outcome of uploads!!
41 Error codes that the rexitcode function can return if unable to
42 check the exit code of a spawned process
51 Supported flavors of Linux OS
61 class LinuxNode(ResourceManager):
63 .. class:: Class Args :
65 :param ec: The Experiment controller
66 :type ec: ExperimentController
67 :param guid: guid of the RM
72 There are different ways in which commands can be executed using the
73 LinuxNode interface (i.e. 'execute' - blocking and non blocking, 'run',
78 * 'execute' (blocking mode) :
80 HOW IT WORKS: 'execute', forks a process and run the
81 command, synchronously, attached to the terminal, in
83 The execute method will block until the command returns
84 the result on 'out', 'err' (so until it finishes executing).
86 USAGE: short-lived commands that must be executed attached
87 to a terminal and in foreground, for which it IS necessary
88 to block until the command has finished (e.g. if you want
89 to run 'ls' or 'cat').
91 * 'execute' (NON blocking mode - blocking = False) :
93 HOW IT WORKS: Same as before, except that execute method
94 will return immediately (even if command still running).
96 USAGE: long-lived commands that must be executed attached
97 to a terminal and in foreground, but for which it is not
98 necessary to block until the command has finished. (e.g.
99 start an application using X11 forwarding)
103 HOW IT WORKS: Connects to the host ( using SSH if remote)
104 and launches the command in background, detached from any
105 terminal (daemonized), and returns. The command continues to
106 run remotely, but since it is detached from the terminal,
107 its pipes (stdin, stdout, stderr) can't be redirected to the
108 console (as normal non detached processes would), and so they
109 are explicitly redirected to files. The pidfile is created as
110 part of the process of launching the command. The pidfile
111 holds the pid and ppid of the process forked in background,
112 so later on it is possible to check whether the command is still
115 USAGE: long-lived commands that can run detached in background,
116 for which it is NOT necessary to block (wait) until the command
117 has finished. (e.g. start an application that is not using X11
118 forwarding. It can run detached and remotely in background)
122 HOW IT WORKS: Similar to 'run' except that it 'blocks' until
123 the command has finished execution. It also checks whether
124 errors occurred during runtime by reading the exitcode file,
125 which contains the exit code of the command that was run
126 (checking stderr only is not always reliable since many
127 commands throw debugging info to stderr and the only way to
128 automatically know whether an error really happened is to
129 check the process exit code).
131 Another difference with respect to 'run', is that instead
132 of directly executing the command as a bash command line,
133 it uploads the command to a bash script and runs the script.
134 This allows to use the bash script to debug errors, since
135 it remains at the remote host and can be run manually to
138 USAGE: medium-lived commands that can run detached in
139 background, for which it IS necessary to block (wait) until
140 the command has finished. (e.g. Package installation,
141 source compilation, file download, etc)
145 _help = "Controls Linux host machines ( either localhost or a host " \
146 "that can be accessed using a SSH key)"
147 _backend_type = "linux"
150 def _register_attributes(cls):
151 hostname = Attribute("hostname", "Hostname of the machine",
152 flags = Flags.Design)
154 username = Attribute("username", "Local account username",
155 flags = Flags.Credential)
157 port = Attribute("port", "SSH port", flags = Flags.Design)
159 home = Attribute("home",
160 "Experiment home directory to store all experiment related files",
161 flags = Flags.Design)
163 identity = Attribute("identity", "SSH identity file",
164 flags = Flags.Credential)
166 server_key = Attribute("serverKey", "Server public key",
167 flags = Flags.Design)
169 clean_home = Attribute("cleanHome", "Remove all nepi files and directories "
170 " from node home folder before starting experiment",
173 flags = Flags.Design)
175 clean_experiment = Attribute("cleanExperiment", "Remove all files and directories "
176 " from a previous same experiment, before the new experiment starts",
179 flags = Flags.Design)
181 clean_processes = Attribute("cleanProcesses",
182 "Kill all running processes before starting experiment",
185 flags = Flags.Design)
187 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
188 "releasing the resource",
189 flags = Flags.Design)
191 gateway_user = Attribute("gatewayUser", "Gateway account username",
192 flags = Flags.Design)
194 gateway = Attribute("gateway", "Hostname of the gateway machine",
195 flags = Flags.Design)
197 cls._register_attribute(hostname)
198 cls._register_attribute(username)
199 cls._register_attribute(port)
200 cls._register_attribute(home)
201 cls._register_attribute(identity)
202 cls._register_attribute(server_key)
203 cls._register_attribute(clean_home)
204 cls._register_attribute(clean_experiment)
205 cls._register_attribute(clean_processes)
206 cls._register_attribute(tear_down)
207 cls._register_attribute(gateway_user)
208 cls._register_attribute(gateway)
210 def __init__(self, ec, guid):
211 super(LinuxNode, self).__init__(ec, guid)
213 # home directory at Linux host
216 # lock to prevent concurrent applications on the same node,
217 # to execute commands at the same time. There are potential
218 # concurrency issues when using SSH to a same host from
219 # multiple threads. There are also possible operational
220 # issues, e.g. an application querying the existence
221 # of a file or folder prior to its creation, and another
222 # application creating the same file or folder in between.
223 self._node_lock = threading.Lock()
225 def log_message(self, msg):
226 return " guid %d - host %s - %s " % (self.guid,
227 self.get("hostname"), msg)
231 home = self.get("home") or ""
232 if not home.startswith("/"):
233 home = os.path.join(self._home_dir, home)
238 return os.path.join(self.home_dir, ".nepi")
242 return os.path.join(self.nepi_home, "nepi-usr")
246 return os.path.join(self.usr_dir, "lib")
250 return os.path.join(self.usr_dir, "bin")
254 return os.path.join(self.usr_dir, "src")
258 return os.path.join(self.usr_dir, "share")
262 return os.path.join(self.nepi_home, "nepi-exp")
266 return os.path.join(self.exp_dir, self.ec.exp_id)
270 return os.path.join(self.exp_home, "node-%d" % self.guid)
274 return os.path.join(self.node_home, self.ec.run_id)
281 if self.get("hostname") not in ["localhost", "127.0.0.1"] and \
282 not self.get("username"):
283 msg = "Can't resolve OS, insufficient data "
285 raise RuntimeError, msg
289 if out.find("Fedora release 8") == 0:
290 self._os = OSType.FEDORA_8
291 elif out.find("Fedora release 12") == 0:
292 self._os = OSType.FEDORA_12
293 elif out.find("Fedora release 14") == 0:
294 self._os = OSType.FEDORA_14
295 elif out.find("Fedora release") == 0:
296 self._os = OSType.FEDORA
297 elif out.find("Debian") == 0:
298 self._os = OSType.DEBIAN
299 elif out.find("Ubuntu") ==0:
300 self._os = OSType.UBUNTU
302 msg = "Unsupported OS"
304 raise RuntimeError, "%s - %s " %( msg, out )
309 # The underlying SSH layer will sometimes return an empty
310 # output (even if the command was executed without errors).
311 # To work arround this, repeat the operation N times or
312 # until the result is not empty string
315 (out, err), proc = self.execute("cat /etc/issue",
319 trace = traceback.format_exc()
320 msg = "Error detecting OS: %s " % trace
321 self.error(msg, out, err)
327 return self.os in [OSType.DEBIAN, OSType.UBUNTU]
331 return self.os in [OSType.FEDORA_12, OSType.FEDORA_14, OSType.FEDORA_8,
336 return self.get("hostname") in ['localhost', '127.0.0.7', '::1']
338 def do_provision(self):
339 # check if host is alive
340 if not self.is_alive():
341 msg = "Deploy failed. Unresponsive node %s" % self.get("hostname")
343 raise RuntimeError, msg
347 if self.get("cleanProcesses"):
348 self.clean_processes()
350 if self.get("cleanHome"):
353 if self.get("cleanExperiment"):
354 self.clean_experiment()
356 # Create shared directory structure and node home directory
357 paths = [self.lib_dir,
365 super(LinuxNode, self).do_provision()
368 if self.state == ResourceState.NEW:
369 self.info("Deploying node")
373 # Node needs to wait until all associated interfaces are
374 # ready before it can finalize deployment
375 from nepi.resources.linux.interface import LinuxInterface
376 ifaces = self.get_connected(LinuxInterface.get_rtype())
378 if iface.state < ResourceState.READY:
379 self.ec.schedule(reschedule_delay, self.deploy)
382 super(LinuxNode, self).do_deploy()
384 def do_release(self):
385 rms = self.get_connected()
387 # Node needs to wait until all associated RMs are released
388 # before it can be released
389 if rm.state != ResourceState.RELEASED:
390 self.ec.schedule(reschedule_delay, self.release)
393 tear_down = self.get("tearDown")
395 self.execute(tear_down)
397 self.clean_processes()
399 super(LinuxNode, self).do_release()
401 def valid_connection(self, guid):
405 def clean_processes(self):
406 self.info("Cleaning up processes")
408 if self.get("hostname") in ["localhost", "127.0.0.2"]:
411 if self.get("username") != 'root':
412 cmd = ("sudo -S killall tcpdump || /bin/true ; " +
413 "sudo -S killall -u %s || /bin/true ; " % self.get("username"))
415 if self.state >= ResourceState.READY:
417 pids = pickle.load(open("/tmp/save.proc", "rb"))
419 ps_aux = "ps aux |awk '{print $2,$11}'"
420 (out, err), proc = self.execute(ps_aux)
421 for line in out.strip().split("\n"):
422 parts = line.strip().split(" ")
423 pids_temp[parts[0]] = parts[1]
424 kill_pids = set(pids_temp.items()) - set(pids.items())
425 kill_pids = ' '.join(dict(kill_pids).keys())
427 cmd = ("killall tcpdump || /bin/true ; " +
428 "kill $(ps aux | grep '[n]epi' | awk '{print $2}') || /bin/true ; " +
429 "kill %s || /bin/true ; " % kill_pids)
431 cmd = ("killall tcpdump || /bin/true ; " +
432 "kill $(ps aux | grep '[n]epi' | awk '{print $2}') || /bin/true ; ")
434 (out, err), proc = self.execute(cmd, retry = 1, with_lock = True)
436 def clean_home(self):
437 """ Cleans all NEPI related folders in the Linux host
439 self.info("Cleaning up home")
441 cmd = "cd %s ; find . -maxdepth 1 -name \.nepi -execdir rm -rf {} + " % (
444 return self.execute(cmd, with_lock = True)
446 def clean_experiment(self):
447 """ Cleans all experiment related files in the Linux host.
448 It preserves NEPI files and folders that have a multi experiment
451 self.info("Cleaning up experiment files")
453 cmd = "cd %s ; find . -maxdepth 1 -name '%s' -execdir rm -rf {} + " % (
457 return self.execute(cmd, with_lock = True)
459 def execute(self, command,
465 connect_timeout = 30,
466 strict_host_checking = False,
471 """ Notice that this invocation will block until the
472 execution finishes. If this is not the desired behavior,
473 use 'run' instead."""
476 (out, err), proc = execfuncs.lexec(command,
477 user = self.get("username"), # still problem with localhost
482 # If the execute command is blocking, we don't want to keep
483 # the node lock. This lock is used to avoid race conditions
484 # when creating the ControlMaster sockets. A more elegant
485 # solution is needed.
486 with self._node_lock:
487 (out, err), proc = sshfuncs.rexec(
489 host = self.get("hostname"),
490 user = self.get("username"),
491 port = self.get("port"),
492 gwuser = self.get("gatewayUser"),
493 gw = self.get("gateway"),
496 identity = self.get("identity"),
497 server_key = self.get("serverKey"),
500 forward_x11 = forward_x11,
502 connect_timeout = connect_timeout,
503 persistent = persistent,
505 strict_host_checking = strict_host_checking
508 (out, err), proc = sshfuncs.rexec(
510 host = self.get("hostname"),
511 user = self.get("username"),
512 port = self.get("port"),
513 gwuser = self.get("gatewayUser"),
514 gw = self.get("gateway"),
517 identity = self.get("identity"),
518 server_key = self.get("serverKey"),
521 forward_x11 = forward_x11,
523 connect_timeout = connect_timeout,
524 persistent = persistent,
526 strict_host_checking = strict_host_checking
529 return (out, err), proc
531 def run(self, command, home,
540 self.debug("Running command '%s'" % command)
543 (out, err), proc = execfuncs.lspawn(command, pidfile,
545 create_home = create_home,
546 stdin = stdin or '/dev/null',
547 stdout = stdout or '/dev/null',
548 stderr = stderr or '/dev/null',
551 with self._node_lock:
552 (out, err), proc = sshfuncs.rspawn(
556 create_home = create_home,
557 stdin = stdin or '/dev/null',
558 stdout = stdout or '/dev/null',
559 stderr = stderr or '/dev/null',
561 host = self.get("hostname"),
562 user = self.get("username"),
563 port = self.get("port"),
564 gwuser = self.get("gatewayUser"),
565 gw = self.get("gateway"),
567 identity = self.get("identity"),
568 server_key = self.get("serverKey"),
572 return (out, err), proc
574 def getpid(self, home, pidfile = "pidfile"):
576 pidtuple = execfuncs.lgetpid(os.path.join(home, pidfile))
578 with self._node_lock:
579 pidtuple = sshfuncs.rgetpid(
580 os.path.join(home, pidfile),
581 host = self.get("hostname"),
582 user = self.get("username"),
583 port = self.get("port"),
584 gwuser = self.get("gatewayUser"),
585 gw = self.get("gateway"),
587 identity = self.get("identity"),
588 server_key = self.get("serverKey")
593 def status(self, pid, ppid):
595 status = execfuncs.lstatus(pid, ppid)
597 with self._node_lock:
598 status = sshfuncs.rstatus(
600 host = self.get("hostname"),
601 user = self.get("username"),
602 port = self.get("port"),
603 gwuser = self.get("gatewayUser"),
604 gw = self.get("gateway"),
606 identity = self.get("identity"),
607 server_key = self.get("serverKey")
612 def kill(self, pid, ppid, sudo = False):
615 status = self.status(pid, ppid)
617 if status == sshfuncs.ProcStatus.RUNNING:
619 (out, err), proc = execfuncs.lkill(pid, ppid, sudo)
621 with self._node_lock:
622 (out, err), proc = sshfuncs.rkill(
624 host = self.get("hostname"),
625 user = self.get("username"),
626 port = self.get("port"),
627 gwuser = self.get("gatewayUser"),
628 gw = self.get("gateway"),
631 identity = self.get("identity"),
632 server_key = self.get("serverKey")
635 return (out, err), proc
637 def copy(self, src, dst):
639 (out, err), proc = execfuncs.lcopy(src, dst,
642 with self._node_lock:
643 (out, err), proc = sshfuncs.rcopy(
645 port = self.get("port"),
646 gwuser = self.get("gatewayUser"),
647 gw = self.get("gateway"),
648 identity = self.get("identity"),
649 server_key = self.get("serverKey"),
651 strict_host_checking = False)
653 return (out, err), proc
655 def upload(self, src, dst, text = False, overwrite = True,
656 raise_on_error = True):
657 """ Copy content to destination
659 src string with the content to copy. Can be:
661 - a string with the path to a local file
662 - a string with a semi-colon separeted list of local files
663 - a string with a local directory
665 dst string with destination path on the remote host (remote is
668 text src is text input, it must be stored into a temp file before
671 # If source is a string input
673 if text and not os.path.isfile(src):
674 # src is text input that should be uploaded as file
675 # create a temporal file with the content to upload
676 f = tempfile.NamedTemporaryFile(delete=False)
681 # If dst files should not be overwritten, check that the files do not
683 if isinstance(src, str):
684 src = map(str.strip, src.split(";"))
686 if overwrite == False:
687 src = self.filter_existing_files(src, dst)
689 return ("", ""), None
691 if not self.localhost:
692 # Build destination as <user>@<server>:<path>
693 dst = "%s@%s:%s" % (self.get("username"), self.get("hostname"), dst)
695 ((out, err), proc) = self.copy(src, dst)
702 msg = " Failed to upload files - src: %s dst: %s" % (";".join(src), dst)
703 self.error(msg, out, err)
705 msg = "%s out: %s err: %s" % (msg, out, err)
707 raise RuntimeError, msg
709 return ((out, err), proc)
711 def download(self, src, dst, raise_on_error = True):
712 if not self.localhost:
713 # Build destination as <user>@<server>:<path>
714 src = "%s@%s:%s" % (self.get("username"), self.get("hostname"), src)
716 ((out, err), proc) = self.copy(src, dst)
719 msg = " Failed to download files - src: %s dst: %s" % (";".join(src), dst)
720 self.error(msg, out, err)
723 raise RuntimeError, msg
725 return ((out, err), proc)
727 def install_packages_command(self, packages):
730 command = rpmfuncs.install_packages_command(self.os, packages)
732 command = debfuncs.install_packages_command(self.os, packages)
734 msg = "Error installing packages ( OS not known ) "
735 self.error(msg, self.os)
736 raise RuntimeError, msg
740 def install_packages(self, packages, home, run_home = None,
741 raise_on_error = True):
742 """ Install packages in the Linux host.
744 'home' is the directory to upload the package installation script.
745 'run_home' is the directory from where to execute the script.
747 command = self.install_packages_command(packages)
749 run_home = run_home or home
751 (out, err), proc = self.run_and_wait(command, run_home,
752 shfile = os.path.join(home, "instpkg.sh"),
753 pidfile = "instpkg_pidfile",
754 ecodefile = "instpkg_exitcode",
755 stdout = "instpkg_stdout",
756 stderr = "instpkg_stderr",
758 raise_on_error = raise_on_error)
760 return (out, err), proc
762 def remove_packages(self, packages, home, run_home = None,
763 raise_on_error = True):
764 """ Uninstall packages from the Linux host.
766 'home' is the directory to upload the package un-installation script.
767 'run_home' is the directory from where to execute the script.
770 command = rpmfuncs.remove_packages_command(self.os, packages)
772 command = debfuncs.remove_packages_command(self.os, packages)
774 msg = "Error removing packages ( OS not known ) "
776 raise RuntimeError, msg
778 run_home = run_home or home
780 (out, err), proc = self.run_and_wait(command, run_home,
781 shfile = os.path.join(home, "rmpkg.sh"),
782 pidfile = "rmpkg_pidfile",
783 ecodefile = "rmpkg_exitcode",
784 stdout = "rmpkg_stdout",
785 stderr = "rmpkg_stderr",
787 raise_on_error = raise_on_error)
789 return (out, err), proc
791 def mkdir(self, paths, clean = False):
792 """ Paths is either a single remote directory path to create,
793 or a list of directories to create.
798 if isinstance(paths, str):
801 cmd = " ; ".join(map(lambda path: "mkdir -p %s" % path, paths))
803 return self.execute(cmd, with_lock = True)
805 def rmdir(self, paths):
806 """ Paths is either a single remote directory path to delete,
807 or a list of directories to delete.
810 if isinstance(paths, str):
813 cmd = " ; ".join(map(lambda path: "rm -rf %s" % path, paths))
815 return self.execute(cmd, with_lock = True)
817 def run_and_wait(self, command, home,
822 ecodefile = "exitcode",
828 raise_on_error = True):
830 Uploads the 'command' to a bash script in the host.
831 Then runs the script detached in background in the host, and
832 busy-waites until the script finishes executing.
835 if not shfile.startswith("/"):
836 shfile = os.path.join(home, shfile)
838 self.upload_command(command,
840 ecodefile = ecodefile,
842 overwrite = overwrite)
844 command = "bash %s" % shfile
845 # run command in background in remote host
846 (out, err), proc = self.run(command, home,
854 # check no errors occurred
856 msg = " Failed to run command '%s' " % command
857 self.error(msg, out, err)
859 raise RuntimeError, msg
861 # Wait for pid file to be generated
862 pid, ppid = self.wait_pid(
865 raise_on_error = raise_on_error)
867 # wait until command finishes to execute
868 self.wait_run(pid, ppid)
870 (eout, err), proc = self.check_errors(home,
871 ecodefile = ecodefile,
874 # Out is what was written in the stderr file
876 msg = " Failed to run command '%s' " % command
877 self.error(msg, eout, err)
880 raise RuntimeError, msg
882 (out, oerr), proc = self.check_output(home, stdout)
884 return (out, err), proc
886 def exitcode(self, home, ecodefile = "exitcode"):
888 Get the exit code of an application.
889 Returns an integer value with the exit code
891 (out, err), proc = self.check_output(home, ecodefile)
893 # Succeeded to open file, return exit code in the file
896 return int(out.strip())
898 # Error in the content of the file!
899 return ExitCode.CORRUPTFILE
901 # No such file or directory
902 if proc.returncode == 1:
903 return ExitCode.FILENOTFOUND
905 # Other error from 'cat'
906 return ExitCode.ERROR
908 def upload_command(self, command,
910 ecodefile = "exitcode",
913 """ Saves the command as a bash script file in the remote host, and
914 forces to save the exit code of the command execution to the ecodefile
917 if not (command.strip().endswith(";") or command.strip().endswith("&")):
920 # The exit code of the command will be stored in ecodefile
921 command = " { %(command)s } ; echo $? > %(ecodefile)s ;" % {
923 'ecodefile': ecodefile,
927 environ = self.format_environment(env)
929 # Add environ to command
930 command = environ + command
932 return self.upload(command, shfile, text = True, overwrite = overwrite)
934 def format_environment(self, env, inline = False):
935 """ Formats the environment variables for a command to be executed
936 either as an inline command
937 (i.e. export PYTHONPATH=src/..; export LALAL= ..;python script.py) or
938 as a bash script (i.e. export PYTHONPATH=src/.. \n export LALA=.. \n)
940 if not env: return ""
942 # Remove extra white spaces
943 env = re.sub(r'\s+', ' ', env.strip())
945 sep = ";" if inline else "\n"
946 return sep.join(map(lambda e: " export %s" % e, env.split(" "))) + sep
948 def check_errors(self, home,
949 ecodefile = "exitcode",
951 """ Checks whether errors occurred while running a command.
952 It first checks the exit code for the command, and only if the
953 exit code is an error one it returns the error output.
959 # get exit code saved in the 'exitcode' file
960 ecode = self.exitcode(home, ecodefile)
962 if ecode in [ ExitCode.CORRUPTFILE, ExitCode.ERROR ]:
963 err = "Error retrieving exit code status from file %s/%s" % (home, ecodefile)
964 elif ecode > 0 or ecode == ExitCode.FILENOTFOUND:
965 # The process returned an error code or didn't exist.
966 # Check standard error.
967 (err, eerr), proc = self.check_output(home, stderr)
969 # If the stderr file was not found, assume nothing bad happened,
970 # and just ignore the error.
971 # (cat returns 1 for error "No such file or directory")
972 if ecode == ExitCode.FILENOTFOUND and proc.poll() == 1:
975 return ("", err), proc
977 def wait_pid(self, home, pidfile = "pidfile", raise_on_error = False):
978 """ Waits until the pid file for the command is generated,
979 and returns the pid and ppid of the process """
984 pidtuple = self.getpid(home = home, pidfile = pidfile)
993 msg = " Failed to get pid for pidfile %s/%s " % (
998 raise RuntimeError, msg
1002 def wait_run(self, pid, ppid, trial = 0):
1003 """ wait for a remote process to finish execution """
1007 status = self.status(pid, ppid)
1009 if status is ProcStatus.FINISHED:
1011 elif status is not ProcStatus.RUNNING:
1014 # If it takes more than 20 seconds to start, then
1015 # asume something went wrong
1019 # The app is running, just wait...
1022 def check_output(self, home, filename):
1023 """ Retrives content of file """
1024 (out, err), proc = self.execute("cat %s" %
1025 os.path.join(home, filename), retry = 1, with_lock = True)
1026 return (out, err), proc
1029 """ Checks if host is responsive
1035 msg = "Unresponsive host. Wrong answer. "
1037 # The underlying SSH layer will sometimes return an empty
1038 # output (even if the command was executed without errors).
1039 # To work arround this, repeat the operation N times or
1040 # until the result is not empty string
1042 (out, err), proc = self.execute("echo 'ALIVE'",
1046 if out.find("ALIVE") > -1:
1049 trace = traceback.format_exc()
1050 msg = "Unresponsive host. Error reaching host: %s " % trace
1052 self.error(msg, out, err)
1055 def find_home(self):
1056 """ Retrieves host home directory
1058 # The underlying SSH layer will sometimes return an empty
1059 # output (even if the command was executed without errors).
1060 # To work arround this, repeat the operation N times or
1061 # until the result is not empty string
1062 msg = "Impossible to retrieve HOME directory"
1064 (out, err), proc = self.execute("echo ${HOME}",
1068 if out.strip() != "":
1069 self._home_dir = out.strip()
1071 trace = traceback.format_exc()
1072 msg = "Impossible to retrieve HOME directory %s" % trace
1074 if not self._home_dir:
1076 raise RuntimeError, msg
1078 def filter_existing_files(self, src, dst):
1079 """ Removes files that already exist in the Linux host from src list
1081 # construct a dictionary with { dst: src }
1082 dests = dict(map(lambda s: (os.path.join(dst, os.path.basename(s)), s), src)) \
1083 if len(src) > 1 else dict({dst: src[0]})
1086 for d in dests.keys():
1087 command.append(" [ -f %(dst)s ] && echo '%(dst)s' " % {'dst' : d} )
1089 command = ";".join(command)
1091 (out, err), proc = self.execute(command, retry = 1, with_lock = True)
1093 for d in dests.keys():
1094 if out.find(d) > -1:
1100 return dests.values()