3 '''automated testing library for testing Samba against windows'''
5 import pexpect, subprocess
6 import sys, os, time, re
9 '''testing of Samba against windows VMs'''
13 self.list_mode = False
14 os.putenv('PYTHONUNBUFFERED', '1')
16 def setvar(self, varname, value):
17 '''set a substitution variable'''
18 self.vars[varname] = value
20 def setwinvars(self, vm, prefix='WIN'):
21 '''setup WIN_XX vars based on a vm name'''
22 for v in ['VM', 'HOSTNAME', 'USER', 'PASS', 'SNAPSHOT', 'BASEDN', 'REALM', 'DOMAIN']:
23 vname = '%s_%s' % (vm, v)
24 if vname in self.vars:
25 self.setvar("%s_%s" % (prefix,v), self.substitute("${%s}" % vname))
27 self.vars.pop("%s_%s" % (prefix,v), None)
30 '''print some information'''
31 if not self.list_mode:
32 print(self.substitute(msg))
34 def load_config(self, fname):
35 '''load the config file'''
39 if len(line) == 0 or line[0] == '#':
41 colon = line.find(':')
43 raise RuntimeError("Invalid config line '%s'" % line)
44 varname = line[0:colon].strip()
45 value = line[colon+1:].strip()
46 self.setvar(varname, value)
48 def list_steps_mode(self):
49 '''put wintest in step listing mode'''
52 def set_skip(self, skiplist):
53 '''set a list of tests to skip'''
54 self.skiplist = skiplist.split(',')
57 '''return True if we should skip a step'''
61 return step in self.skiplist
63 def substitute(self, text):
64 """Substitute strings of the form ${NAME} in text, replacing
65 with substitutions from vars.
67 if isinstance(text, list):
69 for i in range(len(ret)):
70 ret[i] = self.substitute(ret[i])
74 var_start = text.find("${")
77 var_end = text.find("}", var_start)
80 var_name = text[var_start+2:var_end]
81 if not var_name in self.vars:
82 raise RuntimeError("Unknown substitution variable ${%s}" % var_name)
83 text = text.replace("${%s}" % var_name, self.vars[var_name])
86 def have_var(self, varname):
87 '''see if a variable has been set'''
88 return varname in self.vars
91 def putenv(self, key, value):
92 '''putenv with substitution'''
93 os.putenv(key, self.substitute(value))
96 '''chdir with substitution'''
97 os.chdir(self.substitute(dir))
100 def run_cmd(self, cmd, dir=".", show=None, output=False, checkfail=True):
101 cmd = self.substitute(cmd)
102 if isinstance(cmd, list):
103 self.info('$ ' + " ".join(cmd))
105 self.info('$ ' + cmd)
107 return subprocess.Popen([cmd], shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, cwd=dir).communicate()[0]
108 if isinstance(cmd, list):
113 return subprocess.check_call(cmd, shell=shell, cwd=dir)
115 return subprocess.call(cmd, shell=shell, cwd=dir)
118 def cmd_output(self, cmd):
119 '''return output from and command'''
120 cmd = self.substitute(cmd)
121 return self.run_cmd(cmd, output=True)
123 def cmd_contains(self, cmd, contains, nomatch=False, ordered=False, regex=False):
124 '''check that command output contains the listed strings'''
125 out = self.cmd_output(cmd)
127 for c in self.substitute(contains):
129 m = re.search(c, out)
141 raise RuntimeError("Expected to not see %s in %s" % (c, cmd))
144 raise RuntimeError("Expected to see %s in %s" % (c, cmd))
145 if ordered and start != -1:
148 def retry_cmd(self, cmd, contains, retries=30, delay=2, wait_for_fail=False,
149 ordered=False, regex=False):
150 '''retry a command a number of times'''
153 self.cmd_contains(cmd, contains, nomatch=wait_for_fail,
154 ordered=ordered, regex=regex)
158 retries = retries - 1
159 raise RuntimeError("Failed to find %s" % contains)
161 def pexpect_spawn(self, cmd, timeout=60):
162 '''wrapper around pexpect spawn'''
163 cmd = self.substitute(cmd)
164 self.info("$ " + cmd)
165 ret = pexpect.spawn(cmd, logfile=sys.stdout, timeout=timeout)
167 def sendline_sub(line):
168 line = self.substitute(line).replace('\n', '\r\n')
169 return ret.old_sendline(line + '\r')
171 def expect_sub(line, timeout=ret.timeout):
172 line = self.substitute(line)
173 return ret.old_expect(line, timeout=timeout)
175 ret.old_sendline = ret.sendline
176 ret.sendline = sendline_sub
177 ret.old_expect = ret.expect
178 ret.expect = expect_sub
182 def vm_poweroff(self, vmname, checkfail=True):
184 self.setvar('VMNAME', vmname)
185 self.run_cmd("${VM_POWEROFF}", checkfail=checkfail)
187 def vm_restore(self, vmname, snapshot):
189 self.setvar('VMNAME', vmname)
190 self.setvar('SNAPSHOT', snapshot)
191 self.run_cmd("${VM_RESTORE}")
193 def ping_wait(self, hostname):
194 '''wait for a hostname to come up on the network'''
195 hostname = self.substitute(hostname)
199 self.run_cmd("ping -c 1 -w 10 %s" % hostname)
204 raise RuntimeError("Failed to ping %s" % hostname)
205 self.info("Host %s is up" % hostname)
207 def port_wait(self, hostname, port, retries=200, delay=3, wait_for_fail=False):
208 '''wait for a host to come up on the network'''
209 self.retry_cmd("nc -v -z -w 1 %s %u" % (hostname, port), ['succeeded'],
210 retries=retries, delay=delay, wait_for_fail=wait_for_fail)
212 def run_net_time(self, child):
213 '''run net time on windows'''
214 child.sendline("net time \\\\${HOSTNAME} /set")
215 child.expect("Do you want to set the local computer")
217 child.expect("The command completed successfully")
219 def run_date_time(self, child, time_tuple=None):
220 '''run date and time on windows'''
221 if time_tuple is None:
222 time_tuple = time.localtime()
223 child.sendline("date")
224 child.expect("Enter the new date:")
225 child.sendline(time.strftime("%m-%d-%y", time_tuple))
227 child.sendline("time")
228 child.expect("Enter the new time:")
229 child.sendline(time.strftime("%H:%M:%S", time_tuple))
233 def open_telnet(self, hostname, username, password, retries=60, delay=5, set_time=False):
234 '''open a telnet connection to a windows server, return the pexpect child'''
236 child = self.pexpect_spawn("telnet " + hostname + " -l '" + username + "'")
237 i = child.expect(["Welcome to Microsoft Telnet Service",
238 "No more connections are allowed to telnet server",
239 "Unable to connect to remote host",
246 child.expect("password:")
247 child.sendline(password)
250 self.run_date_time(child, None)
252 raise RuntimeError("Failed to connect with telnet")
254 def kinit(self, username, password):
255 '''use kinit to setup a credentials cache'''
256 self.run_cmd("kdestroy")
257 self.putenv('KRB5CCNAME', "${PREFIX}/ccache.test")
258 username = self.substitute(username)
259 s = username.split('@')
262 username = '@'.join(s)
263 child = self.pexpect_spawn('kinit -V ' + username)
264 child.expect("Password for")
265 child.sendline(password)
266 child.expect("Authenticated to Kerberos")