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'
24 # inserts a backslash before each occurence of the following chars
25 # \ " ' < > & | ; ( ) $ * ~
27 def backslash_shell_specials (command):
30 if char in "\\\"'<>&|;()$*~":
36 # check main IP address against the provided hostname
38 def is_local_hostname (hostname):
39 if hostname == "localhost":
43 local_ip = socket.gethostbyname(socket.gethostname())
44 remote_ip = socket.gethostbyname(hostname)
45 return local_ip==remote_ip
47 utils.header("WARNING : something wrong in is_local_hostname with hostname=%s"%hostname)
50 def __init__(self,hostname,buildname=None,key=None, username=None,unknown_host=True):
51 self.hostname=hostname
52 self.buildname=buildname
54 self.username=username
55 self.unknown_host=unknown_host
58 return TestSsh.is_local_hostname(self.hostname)
60 std_options="-o BatchMode=yes -o StrictHostKeyChecking=no -o CheckHostIP=no -o ConnectTimeout=5 "
61 unknown_option="-o UserKnownHostsFile=/dev/null "
66 return "-i %s "%self.key
68 def hostname_part (self):
72 return "%s@%s"%(self.username,self.hostname)
74 # command gets run on the right box
75 def actual_command (self, command,keep_stdin=False):
81 ssh_command += TestSsh.std_options
82 if self.unknown_host: ssh_command += TestSsh.unknown_option
83 ssh_command += self.key_part()
84 ssh_command += "%s %s" %(self.hostname_part(),TestSsh.backslash_shell_specials(command))
88 def actual_argv (self, argv,keep_stdin=False):
92 ssh_argv.append('ssh')
93 if not keep_stdin: ssh_argv.append('-n')
94 ssh_argv += TestSsh.std_options.split()
95 if self.unknown_host: ssh_argv += TestSsh.unknown_option.split()
96 ssh_argv += self.key_part().split()
97 ssh_argv.append(self.hostname_part())
101 def header (self,message):
102 if not message: return
103 print "===============",message
106 def run(self, command,message=None,background=False,dry_run=False):
107 local_command = self.actual_command(command)
109 utils.header("DRY RUN " + local_command)
113 return utils.system(local_command,background)
115 def clean_dir (self,dirname):
118 return self.run("rm -rf %s"%dirname)
120 def mkdir (self,dirname=None,abs=False):
123 return os.path.mkdir(dirname)
127 dirname="%s/%s"%(self.buildname,dirname)
129 dirname=self.buildname
130 return self.run("mkdir -p %s"%dirname)
132 def rmdir (self,dirname=None):
135 return shutil.rmtree(dirname)
138 dirname="%s/%s"%(self.buildname,dirname)
140 dirname=self.buildname
141 return self.run("rm -rf %s"%dirname)
143 def create_buildname_once (self):
146 # create remote buildname on demand
148 self.buildname_created
151 self.buildname_created=True
153 def run_in_buildname (self,command, background=False):
155 return utils.system(command,background)
156 self.create_buildname_once()
157 return self.run("cd %s ; %s"%(self.buildname,command),background)
159 def copy (self,local_file,recursive=False):
162 self.create_buildname_once()
164 scp_command += TestSsh.std_options
165 if recursive: scp_command += "-r "
166 scp_command += self.key_part()
167 scp_command += "%s %s:%s/%s"%(local_file,self.hostname_part(),
168 self.buildname,os.path.basename(local_file) or ".")
169 return utils.system(scp_command)
171 def copy_abs (self,local_file,remote_file,recursive=False):
175 dest= "%s:"%self.hostname_part()
177 scp_command += TestSsh.std_options
178 if recursive: scp_command += "-r "
179 scp_command += self.key_part()
180 scp_command += "%s %s%s"%(local_file,dest,remote_file)
181 return utils.system(scp_command)
183 def copy_home (self, local_file, recursive=False):
184 return self.copy_abs(local_file,os.path.basename(local_file),recursive)
186 def fetch (self, remote_file, local_file, recursive=False):
189 if recursive: command += "-r "
190 command += "%s %s"%(remote_file,local_file)
193 command += TestSsh.std_options
194 if recursive: command += "-r "
195 command += self.key_part()
196 # absolute path - do not preprend buildname
197 if remote_file.find("/")==0:
198 remote_path=remote_file
200 remote_path="%s/%s"%(self.buildname,remote_file)
201 command += "%s:%s %s"%(self.hostname_part(),remote_path,local_file)
202 return utils.system(command)
204 # this is only to avoid harmless message when host cannot be identified
206 # the only place where this is needed is when tring to reach a slice in a node,
207 # which is done from the test master box
208 def clear_known_hosts (self):
209 known_hosts = "%s/.ssh/known_hosts"%os.getenv("HOME")
210 utils.header("Clearing entry for %s in %s"%(self.hostname,known_hosts))
211 return utils.system("sed -i -e /^%s/d %s"%(self.hostname,known_hosts))