1 # Thierry Parmentelat <thierry.parmentelat@inria.fr>
2 # Copyright (C) 2010 INRIA
4 # class for issuing commands on a box, either local or remote
6 # the notion of 'buildname' is for providing each test run with a dir of its own
7 # buildname is generally the name of the build being tested, and can be considered unique
9 # thus 'run_in_buildname' mostly :
10 # (*) either runs locally in . - as on a local node we are already in a dedicated directory
11 # (*) or makes sure that there's a remote dir called 'buildname' and runs in it
13 # also, the copy operations
14 # (*) either do nothing if ran locally
15 # (*) or copy a local file into the remote 'buildname'
25 # inserts a backslash before each occurence of the following chars
26 # \ " ' < > & | ; ( ) $ * ~
28 def backslash_shell_specials (command):
31 if char in "\\\"'<>&|;()$*~":
37 # check main IP address against the provided hostname
39 def is_local_hostname (hostname):
40 if hostname == "localhost":
44 local_ip = socket.gethostbyname(socket.gethostname())
45 remote_ip = socket.gethostbyname(hostname)
46 return local_ip==remote_ip
48 utils.header("WARNING : something wrong in is_local_hostname with hostname=%s"%hostname)
51 def __init__(self,hostname,buildname=None,key=None, username=None,unknown_host=True):
52 self.hostname=hostname
53 self.buildname=buildname
55 self.username=username
56 self.unknown_host=unknown_host
59 return TestSsh.is_local_hostname(self.hostname)
61 std_options="-o BatchMode=yes -o StrictHostKeyChecking=no -o CheckHostIP=no -o ConnectTimeout=5 "
62 unknown_option="-o UserKnownHostsFile=/dev/null "
67 return "-i %s "%self.key
69 def hostname_part (self):
73 return "%s@%s"%(self.username,self.hostname)
75 # command gets run on the right box
76 def actual_command (self, command,keep_stdin=False):
82 ssh_command += TestSsh.std_options
83 if self.unknown_host: ssh_command += TestSsh.unknown_option
84 ssh_command += self.key_part()
85 ssh_command += "%s %s" %(self.hostname_part(),TestSsh.backslash_shell_specials(command))
89 def actual_argv (self, argv,keep_stdin=False):
93 ssh_argv.append('ssh')
94 if not keep_stdin: ssh_argv.append('-n')
95 ssh_argv += TestSsh.std_options.split()
96 if self.unknown_host: ssh_argv += TestSsh.unknown_option.split()
97 ssh_argv += self.key_part().split()
98 ssh_argv.append(self.hostname_part())
102 def header (self,message):
103 if not message: return
104 print "===============",message
107 def run(self, command,message=None,background=False,dry_run=False):
108 local_command = self.actual_command(command)
110 utils.header("DRY RUN " + local_command)
114 return utils.system(local_command,background)
116 def clean_dir (self,dirname):
119 return self.run("rm -rf %s"%dirname)
121 def mkdir (self,dirname=None,abs=False):
124 return os.path.mkdir(dirname)
128 dirname="%s/%s"%(self.buildname,dirname)
130 dirname=self.buildname
131 return self.run("mkdir -p %s"%dirname)
133 def rmdir (self,dirname=None):
136 return shutil.rmtree(dirname)
139 dirname="%s/%s"%(self.buildname,dirname)
141 dirname=self.buildname
142 return self.run("rm -rf %s"%dirname)
144 def create_buildname_once (self):
147 # create remote buildname on demand
149 self.buildname_created
152 self.buildname_created=True
154 def run_in_buildname (self,command, background=False):
156 return utils.system(command,background)
157 self.create_buildname_once()
158 return self.run("cd %s ; %s"%(self.buildname,command),background)
160 def copy (self,local_file,recursive=False):
163 self.create_buildname_once()
165 scp_command += TestSsh.std_options
166 if recursive: scp_command += "-r "
167 scp_command += self.key_part()
168 scp_command += "%s %s:%s/%s"%(local_file,self.hostname_part(),
169 self.buildname,os.path.basename(local_file) or ".")
170 return utils.system(scp_command)
172 def copy_abs (self,local_file,remote_file,recursive=False):
176 dest= "%s:"%self.hostname_part()
178 scp_command += TestSsh.std_options
179 if recursive: scp_command += "-r "
180 scp_command += self.key_part()
181 scp_command += "%s %s%s"%(local_file,dest,remote_file)
182 return utils.system(scp_command)
184 def copy_home (self, local_file, recursive=False):
185 return self.copy_abs(local_file,os.path.basename(local_file),recursive)
187 def fetch (self, remote_file, local_file, recursive=False):
190 if recursive: command += "-r "
191 command += "%s %s"%(remote_file,local_file)
194 command += TestSsh.std_options
195 if recursive: command += "-r "
196 command += self.key_part()
197 # absolute path - do not preprend buildname
198 if remote_file.find("/")==0:
199 remote_path=remote_file
201 remote_path="%s/%s"%(self.buildname,remote_file)
202 command += "%s:%s %s"%(self.hostname_part(),remote_path,local_file)
203 return utils.system(command)
205 # this is only to avoid harmless message when host cannot be identified
207 # the only place where this is needed is when tring to reach a slice in a node,
208 # which is done from the test master box
209 def clear_known_hosts (self):
210 known_hosts = "%s/.ssh/known_hosts"%os.getenv("HOME")
211 utils.header("Clearing entry for %s in %s"%(self.hostname,known_hosts))
212 return utils.system("sed -i -e /^%s/d %s"%(self.hostname,known_hosts))