X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=system%2FTestSsh.py;h=cde5a18929b7c9fd35f41fc1b70d83acd97dfa02;hb=510d4f034ed4bd4f8abb00cf04abcfbe53ab3ccd;hp=cae5fa413d918ef466b2a4665d7a4c3ac4847958;hpb=4752a573406d72f89495e6e6b6fadd0ac02e0aab;p=tests.git

diff --git a/system/TestSsh.py b/system/TestSsh.py
index cae5fa4..cde5a18 100644
--- a/system/TestSsh.py
+++ b/system/TestSsh.py
@@ -15,6 +15,7 @@
 # (*) or copy a local file into the remote 'buildname' 
 # 
 
+import sys
 import os.path
 import utils
 import shutil
@@ -24,35 +25,45 @@ class TestSsh:
     # inserts a backslash before each occurence of the following chars
     # \ " ' < > & | ; ( ) $ * ~ 
     @staticmethod
-    def backslash_shell_specials (command):
-        result=''
+    def backslash_shell_specials(command):
+        result = ''
         for char in command:
             if char in "\\\"'<>&|;()$*~":
-                result +='\\'+char
+                result += '\\'+char
             else:
-                result +=char
+                result += char
         return result
 
     # check main IP address against the provided hostname
     @staticmethod
-    def is_local_hostname (hostname):
+    def is_local_hostname(hostname):
         if hostname == "localhost":
             return True
         import socket
         try:
             local_ip = socket.gethostbyname(socket.gethostname())
             remote_ip = socket.gethostbyname(hostname)
-            return local_ip==remote_ip
+            return local_ip == remote_ip
         except:
-            utils.header("WARNING : something wrong in is_local_hostname with hostname=%s"%hostname)
+            utils.header("WARNING : something wrong in is_local_hostname with hostname={}".format(hostname))
             return False
 
-    def __init__(self,hostname,buildname=None,key=None, username=None,unknown_host=True):
-        self.hostname=hostname
-        self.buildname=buildname
-        self.key=key
-        self.username=username
-        self.unknown_host=unknown_host
+    # some boxes have their working space in user's homedir (/root), 
+    # some others in a dedicated area with max. space (/vservers)
+    # when root is not specified we use the homedir
+    def __init__(self, hostname, buildname=None, key=None, username=None, unknown_host=True, root=None):
+        self.hostname = hostname
+        self.buildname = buildname
+        self.key = key
+        self.username = username
+        self.unknown_host = unknown_host
+        self.root = root
+
+    def __repr__(self):
+        result = "{}@{}".format(self.username or 'root', self.hostname)
+        if self.key:
+            result += " <key {}>".format(self.key)
+        return result
 
     def is_local(self):
         return TestSsh.is_local_hostname(self.hostname)
@@ -60,148 +71,186 @@ class TestSsh:
     std_options="-o BatchMode=yes -o StrictHostKeyChecking=no -o CheckHostIP=no -o ConnectTimeout=5 "
     unknown_option="-o UserKnownHostsFile=/dev/null "
     
-    def key_part (self):
+    def key_part(self):
         if not self.key:
             return ""
-        return "-i %s "%self.key
+        return "-i {} ".format(self.key)
 
-    def hostname_part (self):
+    def hostname_part(self):
         if not self.username:
             return self.hostname
         else:
-            return "%s@%s"%(self.username,self.hostname)
+            return "{}@{}".format(self.username,self.hostname)
     
     # command gets run on the right box
-    def actual_command (self, command,keep_stdin=False):
+    def actual_command(self, command, keep_stdin=False, dry_run=False, backslash=True):
         if self.is_local():
             return command
         ssh_command = "ssh "
-        if not keep_stdin:
-            ssh_command += "-n "
-        ssh_command += TestSsh.std_options
-        if self.unknown_host: ssh_command += TestSsh.unknown_option
+        if not dry_run:
+            if not keep_stdin:
+                ssh_command += "-n "
+            ssh_command += TestSsh.std_options
+            if self.unknown_host: ssh_command += TestSsh.unknown_option
         ssh_command += self.key_part()
-        ssh_command += "%s %s" %(self.hostname_part(),TestSsh.backslash_shell_specials(command))
+        ssh_command += self.hostname_part() + " "
+        if backslash:
+            ssh_command += TestSsh.backslash_shell_specials(command)
+        else:
+            ssh_command += command
         return ssh_command
 
     # same in argv form
-    def actual_argv (self, argv,keep_stdin=False):
+    def actual_argv (self, argv, keep_stdin=False, dry_run=False):
         if self.is_local():
             return argv
-        ssh_argv=[]
+        ssh_argv = []
         ssh_argv.append('ssh')
-        if not keep_stdin: ssh_argv.append('-n')
-        ssh_argv += TestSsh.std_options.split()
-        if self.unknown_host: ssh_argv += TestSsh.unknown_option.split()
+        if not dry_run:
+            if not keep_stdin:
+                ssh_argv.append('-n')
+            ssh_argv += TestSsh.std_options.split()
+            if self.unknown_host:
+                ssh_argv += TestSsh.unknown_option.split()
         ssh_argv += self.key_part().split()
         ssh_argv.append(self.hostname_part())
         ssh_argv += argv
         return ssh_argv
 
-    def header (self,message):
-        if not message: return
-        print "===============",message
+    def header(self, message):
+        if not message:
+            return
+        print("===============",message)
         sys.stdout.flush()
 
-    def run(self, command,message=None,background=False):
-        local_command = self.actual_command(command)
-        self.header(message)
-        return utils.system(local_command,background)
+    def run(self, command, message=None, background=False, dry_run=False):
+        local_command = self.actual_command(command, dry_run=dry_run)
+        if dry_run:
+            utils.header("DRY RUN " + local_command)
+            return 0
+        else:
+            self.header(message)
+            return utils.system(local_command, background)
 
-    def clean_dir (self,dirname):
+    def run_in_buildname(self, command, background=False, dry_run=False):
         if self.is_local():
-            return 0
-        return self.run("rm -rf %s"%dirname)
+            return utils.system(command, background)
+        self.create_buildname_once(dry_run)
+        return self.run("cd {} ; {}".format(self.fullname(self.buildname), command),
+                        background=background, dry_run=dry_run)
 
-    def mkdir (self,dirname=None):
+    def fullname(self, dirname):
+        if self.root==None:
+            return dirname
+        else:
+            return os.path.join(self.root,dirname)
+        
+    def mkdir(self, dirname=None, abs=False, dry_run=False):
         if self.is_local():
             if dirname:
                 return os.path.mkdir(dirname)
             return 0
-        if dirname:
-            dirname="%s/%s"%(self.buildname,dirname)
-        else:
-            dirname=self.buildname
-        return self.run("mkdir -p %s"%dirname)
+        # ab. paths remain as-is
+        if not abs:
+            if dirname:
+                dirname = "{}/{}".format(self.buildname, dirname)
+            else:
+                dirname = self.buildname
+            dirname = self.fullname(dirname)
+        if dirname == '.':
+            return
+        return self.run("mkdir -p {}".format(dirname), dry_run=dry_run)
 
-    def rmdir (self,dirname=None):
+    def rmdir(self, dirname=None, dry_run=False):
         if self.is_local():
             if dirname:
                 return shutil.rmtree(dirname)
             return 0
         if dirname:
-            dirname="%s/%s"%(self.buildname,dirname)
+            dirname = "{}/{}".format(self.buildname, dirname)
         else:
-            dirname=self.buildname
-        return self.run("rm -rf %s"%dirname)
+            dirname = self.buildname
+        dirname = self.fullname(dirname)
+        return self.run("rm -rf {}".format(dirname), dry_run=dry_run)
 
-    def create_buildname_once (self):
+    def create_buildname_once(self, dry_run):
         if self.is_local():
             return
         # create remote buildname on demand
         try:
             self.buildname_created
         except:
-            self.mkdir()
-            self.buildname_created=True
+            self.mkdir(dry_run=dry_run)
+            self.buildname_created = True
 
-    def run_in_buildname (self,command, background=False):
-        if self.is_local():
-            return utils.system(command,background)
-        self.create_buildname_once()
-        return self.run("cd %s ; %s"%(self.buildname,command),background)
-
-    def copy (self,local_file,recursive=False):
+    def copy(self, local_file, recursive=False, dry_run=False):
         if self.is_local():
             return 0
-        self.create_buildname_once()
-        scp_command="scp "
-        scp_command += TestSsh.std_options
-        if recursive: scp_command += "-r "
+        self.create_buildname_once(dry_run)
+        scp_command = "scp "
+        if not dry_run:
+            scp_command += TestSsh.std_options
+        if recursive:
+            scp_command += "-r "
         scp_command += self.key_part()
-        scp_command += "%s %s:%s/%s"%(local_file,self.hostname_part(),
-                                      self.buildname,os.path.basename(local_file) or ".")
+        scp_command += "{} {}:{}/{}".format(local_file, self.hostname_part(),
+                                            self.fullname(self.buildname),
+                                            os.path.basename(local_file) or ".")
+        if dry_run:
+            utils.header("DRY RUN TestSsh.copy {}".format(scp_command))
+            # need to be consistent with the non-dry-run mode
+            return 0
         return utils.system(scp_command)
 
-    def copy_abs (self,local_file,remote_file,recursive=False):
+    def copy_abs(self, local_file, remote_file,
+                 recursive=False, dry_run=False):
         if self.is_local():
-            dest=""
+            dest = ""
         else:
-            dest= "%s:"%self.hostname_part()
-        scp_command="scp "
+            dest = "{}:".format(self.hostname_part())
+        scp_command = "scp "
         scp_command += TestSsh.std_options
-        if recursive: scp_command += "-r "
+        if recursive:
+            scp_command += "-r "
         scp_command += self.key_part()
-        scp_command += "%s %s%s"%(local_file,dest,remote_file)
+        scp_command += "{} {}{}".format(local_file, dest, remote_file)
+        if dry_run:
+            utils.header("DRY RUN TestSsh.copy {}".format(scp_command))
+            # need to be consistent with the non-dry-run mode
+            return 0
         return utils.system(scp_command)
 
-    def copy_home (self, local_file, recursive=False):
-        return self.copy_abs(local_file,os.path.basename(local_file),recursive)
+    def copy_home(self, local_file, recursive=False):
+        return self.copy_abs(local_file, os.path.basename(local_file), recursive)
 
-    def fetch (self, remote_file, local_file, recursive=False):
+    def fetch (self, remote_file, local_file, recursive=False, dry_run=False):
         if self.is_local():
             command="cp "
-            if recursive: command += "-r "
-            command += "%s %s"%(remote_file,local_file)
+            if recursive:
+                command += "-r "
+            command += "{} {}".format(remote_file, local_file)
         else:
-            command="scp "
-            command += TestSsh.std_options
-            if recursive: command += "-r "
+            command = "scp "
+            if not dry_run:
+                command += TestSsh.std_options
+            if recursive:
+                command += "-r "
             command += self.key_part()
             # absolute path - do not preprend buildname
-            if remote_file.find("/")==0:
-                remote_path=remote_file
+            if remote_file.find("/") == 0:
+                remote_path = remote_file
             else:
-                remote_path="%s/%s"%(self.buildname,remote_file)
-            command += "%s:%s %s"%(self.hostname_part(),remote_path,local_file)
+                remote_path = "{}/{}".format(self.buildname, remote_file)
+                remote_path = self.fullname(remote_path)
+            command += "{}:{} {}".format(self.hostname_part(), remote_path, local_file)
         return utils.system(command)
 
     # this is only to avoid harmless message when host cannot be identified
     # convenience only
     # the only place where this is needed is when tring to reach a slice in a node,
     # which is done from the test master box
-    def clear_known_hosts (self):
-        known_hosts = "%s/.ssh/known_hosts"%os.getenv("HOME")
-        utils.header("Clearing entry for %s in %s"%(self.hostname,known_hosts))
-        return utils.system("sed -i -e /^%s/d %s"%(self.hostname,known_hosts))
+    def clear_known_hosts(self):
+        known_hosts = "{}/.ssh/known_hosts".format(os.getenv("HOME"))
+        utils.header("Clearing entry for {} in {}".format(self.hostname, known_hosts))
+        return utils.system("sed -i -e /^{}/d {}".format(self.hostname, known_hosts))