rev |
line source |
igor@333
|
1 #!/usr/bin/env python
|
igor@333
|
2 #
|
igor@333
|
3 # This program takes something that resembles a shell script and runs
|
igor@333
|
4 # it, spitting input (commands from the script) and output into text
|
igor@333
|
5 # files, for use in examples.
|
igor@333
|
6
|
igor@333
|
7 import cStringIO
|
igor@333
|
8 import errno
|
igor@333
|
9 import getopt
|
igor@333
|
10 import os
|
igor@333
|
11 import pty
|
igor@333
|
12 import re
|
igor@333
|
13 import select
|
igor@333
|
14 import shutil
|
igor@333
|
15 import signal
|
igor@333
|
16 import stat
|
igor@333
|
17 import sys
|
igor@333
|
18 import tempfile
|
igor@333
|
19 import time
|
igor@333
|
20
|
igor@333
|
21 tex_subs = {
|
igor@333
|
22 '\\': '\\textbackslash{}',
|
igor@333
|
23 '{': '\\{',
|
igor@333
|
24 '}': '\\}',
|
igor@333
|
25 }
|
igor@333
|
26
|
igor@333
|
27 def gensubs(s):
|
igor@333
|
28 start = 0
|
igor@333
|
29 for i, c in enumerate(s):
|
igor@333
|
30 sub = tex_subs.get(c)
|
igor@333
|
31 if sub:
|
igor@333
|
32 yield s[start:i]
|
igor@333
|
33 start = i + 1
|
igor@333
|
34 yield sub
|
igor@333
|
35 yield s[start:]
|
igor@333
|
36
|
igor@333
|
37 def tex_escape(s):
|
igor@333
|
38 return ''.join(gensubs(s))
|
igor@333
|
39
|
igor@333
|
40 def maybe_unlink(name):
|
igor@333
|
41 try:
|
igor@333
|
42 os.unlink(name)
|
igor@333
|
43 return True
|
igor@333
|
44 except OSError, err:
|
igor@333
|
45 if err.errno != errno.ENOENT:
|
igor@333
|
46 raise
|
igor@333
|
47 return False
|
igor@333
|
48
|
igor@333
|
49 def find_path_to(program):
|
igor@333
|
50 for p in os.environ.get('PATH', os.defpath).split(os.pathsep):
|
igor@333
|
51 name = os.path.join(p, program)
|
igor@333
|
52 if os.access(name, os.X_OK):
|
igor@333
|
53 return p
|
igor@333
|
54 return None
|
igor@333
|
55
|
igor@333
|
56 class example:
|
igor@333
|
57 shell = '/usr/bin/env bash'
|
igor@333
|
58 ps1 = '__run_example_ps1__ '
|
igor@333
|
59 ps2 = '__run_example_ps2__ '
|
igor@333
|
60 pi_re = re.compile(r'#\$\s*(name|ignore):\s*(.*)$')
|
igor@333
|
61
|
igor@333
|
62 timeout = 10
|
igor@333
|
63
|
igor@333
|
64 def __init__(self, name, verbose):
|
igor@333
|
65 self.name = name
|
igor@333
|
66 self.verbose = verbose
|
igor@333
|
67 self.poll = select.poll()
|
igor@333
|
68
|
igor@333
|
69 def parse(self):
|
igor@333
|
70 '''yield each hunk of input from the file.'''
|
igor@333
|
71 fp = open(self.name)
|
igor@333
|
72 cfp = cStringIO.StringIO()
|
igor@333
|
73 for line in fp:
|
igor@333
|
74 cfp.write(line)
|
igor@333
|
75 if not line.rstrip().endswith('\\'):
|
igor@333
|
76 yield cfp.getvalue()
|
igor@333
|
77 cfp.seek(0)
|
igor@333
|
78 cfp.truncate()
|
igor@333
|
79
|
igor@333
|
80 def status(self, s):
|
igor@333
|
81 sys.stdout.write(s)
|
igor@333
|
82 if not s.endswith('\n'):
|
igor@333
|
83 sys.stdout.flush()
|
igor@333
|
84
|
igor@333
|
85 def send(self, s):
|
igor@333
|
86 if self.verbose:
|
igor@333
|
87 print >> sys.stderr, '>', self.debugrepr(s)
|
igor@333
|
88 while s:
|
igor@333
|
89 count = os.write(self.cfd, s)
|
igor@333
|
90 s = s[count:]
|
igor@333
|
91
|
igor@333
|
92 def debugrepr(self, s):
|
igor@333
|
93 rs = repr(s)
|
igor@333
|
94 limit = 60
|
igor@333
|
95 if len(rs) > limit:
|
igor@333
|
96 return ('%s%s ... [%d bytes]' % (rs[:limit], rs[0], len(s)))
|
igor@333
|
97 else:
|
igor@333
|
98 return rs
|
igor@333
|
99
|
igor@333
|
100 timeout = 5
|
igor@333
|
101
|
igor@333
|
102 def read(self, hint):
|
igor@333
|
103 events = self.poll.poll(self.timeout * 1000)
|
igor@333
|
104 if not events:
|
igor@333
|
105 print >> sys.stderr, ('[%stimed out after %d seconds]' %
|
igor@333
|
106 (hint, self.timeout))
|
igor@333
|
107 os.kill(self.pid, signal.SIGHUP)
|
igor@333
|
108 return ''
|
igor@333
|
109 return os.read(self.cfd, 1024)
|
igor@333
|
110
|
igor@333
|
111 def receive(self, hint):
|
igor@333
|
112 out = cStringIO.StringIO()
|
igor@333
|
113 while True:
|
igor@333
|
114 try:
|
igor@333
|
115 if self.verbose:
|
igor@333
|
116 sys.stderr.write('< ')
|
igor@333
|
117 s = self.read(hint)
|
igor@333
|
118 except OSError, err:
|
igor@333
|
119 if err.errno == errno.EIO:
|
igor@333
|
120 return '', ''
|
igor@333
|
121 raise
|
igor@333
|
122 if self.verbose:
|
igor@333
|
123 print >> sys.stderr, self.debugrepr(s)
|
igor@333
|
124 out.write(s)
|
igor@333
|
125 s = out.getvalue()
|
igor@333
|
126 if s.endswith(self.ps1):
|
igor@333
|
127 return self.ps1, s.replace('\r\n', '\n')[:-len(self.ps1)]
|
igor@333
|
128 if s.endswith(self.ps2):
|
igor@333
|
129 return self.ps2, s.replace('\r\n', '\n')[:-len(self.ps2)]
|
igor@333
|
130
|
igor@333
|
131 def sendreceive(self, s, hint):
|
igor@333
|
132 self.send(s)
|
igor@333
|
133 ps, r = self.receive(hint)
|
igor@333
|
134 if r.startswith(s):
|
igor@333
|
135 r = r[len(s):]
|
igor@333
|
136 return ps, r
|
igor@333
|
137
|
igor@333
|
138 def run(self):
|
igor@333
|
139 ofp = None
|
igor@333
|
140 basename = os.path.basename(self.name)
|
igor@333
|
141 self.status('running %s ' % basename)
|
igor@333
|
142 tmpdir = tempfile.mkdtemp(prefix=basename)
|
igor@333
|
143
|
igor@333
|
144 # remove the marker file that we tell make to use to see if
|
igor@333
|
145 # this run succeeded
|
igor@333
|
146 maybe_unlink(self.name + '.run')
|
igor@333
|
147
|
igor@333
|
148 rcfile = os.path.join(tmpdir, '.hgrc')
|
igor@333
|
149 rcfp = open(rcfile, 'w')
|
igor@333
|
150 print >> rcfp, '[ui]'
|
igor@333
|
151 print >> rcfp, "username = Bryan O'Sullivan <bos@serpentine.com>"
|
igor@333
|
152
|
igor@333
|
153 rcfile = os.path.join(tmpdir, '.bashrc')
|
igor@333
|
154 rcfp = open(rcfile, 'w')
|
igor@333
|
155 print >> rcfp, 'PS1="%s"' % self.ps1
|
igor@333
|
156 print >> rcfp, 'PS2="%s"' % self.ps2
|
igor@333
|
157 print >> rcfp, 'unset HISTFILE'
|
igor@333
|
158 path = ['/usr/bin', '/bin']
|
igor@333
|
159 hg = find_path_to('hg')
|
igor@333
|
160 if hg and hg not in path:
|
igor@333
|
161 path.append(hg)
|
igor@333
|
162 def re_export(envar):
|
igor@333
|
163 v = os.getenv(envar)
|
igor@333
|
164 if v is not None:
|
igor@333
|
165 print >> rcfp, 'export ' + envar + '=' + v
|
igor@333
|
166 print >> rcfp, 'export PATH=' + ':'.join(path)
|
igor@333
|
167 re_export('PYTHONPATH')
|
igor@333
|
168 print >> rcfp, 'export EXAMPLE_DIR="%s"' % os.getcwd()
|
igor@333
|
169 print >> rcfp, 'export HGMERGE=merge'
|
igor@333
|
170 print >> rcfp, 'export LANG=C'
|
igor@333
|
171 print >> rcfp, 'export LC_ALL=C'
|
igor@333
|
172 print >> rcfp, 'export TZ=GMT'
|
igor@333
|
173 print >> rcfp, 'export HGRC="%s/.hgrc"' % tmpdir
|
igor@333
|
174 print >> rcfp, 'export HGRCPATH=$HGRC'
|
igor@333
|
175 print >> rcfp, 'cd %s' % tmpdir
|
igor@333
|
176 rcfp.close()
|
igor@333
|
177 sys.stdout.flush()
|
igor@333
|
178 sys.stderr.flush()
|
igor@333
|
179 self.pid, self.cfd = pty.fork()
|
igor@333
|
180 if self.pid == 0:
|
igor@333
|
181 cmdline = ['/usr/bin/env', '-i', 'bash', '--noediting',
|
igor@333
|
182 '--noprofile', '--norc']
|
igor@333
|
183 try:
|
igor@333
|
184 os.execv(cmdline[0], cmdline)
|
igor@333
|
185 except OSError, err:
|
igor@333
|
186 print >> sys.stderr, '%s: %s' % (cmdline[0], err.strerror)
|
igor@333
|
187 sys.stderr.flush()
|
igor@333
|
188 os._exit(0)
|
igor@333
|
189 self.poll.register(self.cfd, select.POLLIN | select.POLLERR |
|
igor@333
|
190 select.POLLHUP)
|
igor@333
|
191
|
igor@333
|
192 prompts = {
|
igor@333
|
193 '': '',
|
igor@333
|
194 self.ps1: '$',
|
igor@333
|
195 self.ps2: '>',
|
igor@333
|
196 }
|
igor@333
|
197
|
igor@333
|
198 ignore = [
|
igor@333
|
199 r'\d+:[0-9a-f]{12}', # changeset number:hash
|
igor@333
|
200 r'[0-9a-f]{40}', # long changeset hash
|
igor@333
|
201 r'[0-9a-f]{12}', # short changeset hash
|
igor@333
|
202 r'^(?:---|\+\+\+) .*', # diff header with dates
|
igor@333
|
203 r'^date:.*', # date
|
igor@333
|
204 #r'^diff -r.*', # "diff -r" is followed by hash
|
igor@333
|
205 r'^# Date \d+ \d+', # hg patch header
|
igor@333
|
206 ]
|
igor@333
|
207
|
igor@333
|
208 err = False
|
igor@333
|
209 read_hint = ''
|
igor@333
|
210
|
igor@333
|
211 try:
|
igor@333
|
212 try:
|
igor@333
|
213 # eat first prompt string from shell
|
igor@333
|
214 self.read(read_hint)
|
igor@333
|
215 # setup env and prompt
|
igor@333
|
216 ps, output = self.sendreceive('source %s\n' % rcfile,
|
igor@333
|
217 read_hint)
|
igor@333
|
218 for hunk in self.parse():
|
igor@333
|
219 # is this line a processing instruction?
|
igor@333
|
220 m = self.pi_re.match(hunk)
|
igor@333
|
221 if m:
|
igor@333
|
222 pi, rest = m.groups()
|
igor@333
|
223 if pi == 'name':
|
igor@333
|
224 self.status('.')
|
igor@333
|
225 out = rest
|
igor@333
|
226 if out in ('err', 'lxo', 'out', 'run', 'tmp'):
|
igor@333
|
227 print >> sys.stderr, ('%s: illegal section '
|
igor@333
|
228 'name %r' %
|
igor@333
|
229 (self.name, out))
|
igor@333
|
230 return 1
|
igor@333
|
231 assert os.sep not in out
|
igor@333
|
232 if ofp is not None:
|
igor@333
|
233 ofp.close()
|
igor@333
|
234 err |= self.rename_output(ofp_basename, ignore)
|
igor@333
|
235 if out:
|
igor@333
|
236 ofp_basename = '%s.%s' % (self.name, out)
|
igor@333
|
237 read_hint = ofp_basename + ' '
|
igor@333
|
238 ofp = open(ofp_basename + '.tmp', 'w')
|
igor@333
|
239 else:
|
igor@333
|
240 ofp = None
|
igor@333
|
241 elif pi == 'ignore':
|
igor@333
|
242 ignore.append(rest)
|
igor@333
|
243 elif hunk.strip():
|
igor@333
|
244 # it's something we should execute
|
igor@333
|
245 newps, output = self.sendreceive(hunk, read_hint)
|
igor@333
|
246 if not ofp:
|
igor@333
|
247 continue
|
igor@333
|
248 # first, print the command we ran
|
igor@333
|
249 if not hunk.startswith('#'):
|
igor@333
|
250 nl = hunk.endswith('\n')
|
igor@333
|
251 hunk = ('%s \\textbf{%s}' %
|
igor@333
|
252 (prompts[ps],
|
igor@333
|
253 tex_escape(hunk.rstrip('\n'))))
|
igor@333
|
254 if nl: hunk += '\n'
|
igor@333
|
255 ofp.write(hunk)
|
igor@333
|
256 # then its output
|
igor@333
|
257 ofp.write(tex_escape(output))
|
igor@333
|
258 ps = newps
|
igor@333
|
259 self.status('\n')
|
igor@333
|
260 except:
|
igor@333
|
261 print >> sys.stderr, '(killed)'
|
igor@333
|
262 os.kill(self.pid, signal.SIGKILL)
|
igor@333
|
263 pid, rc = os.wait()
|
igor@333
|
264 raise
|
igor@333
|
265 else:
|
igor@333
|
266 try:
|
igor@333
|
267 ps, output = self.sendreceive('exit\n', read_hint)
|
igor@333
|
268 if ofp is not None:
|
igor@333
|
269 ofp.write(output)
|
igor@333
|
270 ofp.close()
|
igor@333
|
271 err |= self.rename_output(ofp_basename, ignore)
|
igor@333
|
272 os.close(self.cfd)
|
igor@333
|
273 except IOError:
|
igor@333
|
274 pass
|
igor@333
|
275 os.kill(self.pid, signal.SIGTERM)
|
igor@333
|
276 pid, rc = os.wait()
|
igor@333
|
277 err = err or rc
|
igor@333
|
278 if err:
|
igor@333
|
279 if os.WIFEXITED(rc):
|
igor@333
|
280 print >> sys.stderr, '(exit %s)' % os.WEXITSTATUS(rc)
|
igor@333
|
281 elif os.WIFSIGNALED(rc):
|
igor@333
|
282 print >> sys.stderr, '(signal %s)' % os.WTERMSIG(rc)
|
igor@333
|
283 else:
|
igor@333
|
284 open(self.name + '.run', 'w')
|
igor@333
|
285 return err
|
igor@333
|
286 finally:
|
igor@333
|
287 shutil.rmtree(tmpdir)
|
igor@333
|
288
|
igor@333
|
289 def rename_output(self, base, ignore):
|
igor@333
|
290 mangle_re = re.compile('(?:' + '|'.join(ignore) + ')')
|
igor@333
|
291 def mangle(s):
|
igor@333
|
292 return mangle_re.sub('', s)
|
igor@333
|
293 def matchfp(fp1, fp2):
|
igor@333
|
294 while True:
|
igor@333
|
295 s1 = mangle(fp1.readline())
|
igor@333
|
296 s2 = mangle(fp2.readline())
|
igor@333
|
297 if cmp(s1, s2):
|
igor@333
|
298 break
|
igor@333
|
299 if not s1:
|
igor@333
|
300 return True
|
igor@333
|
301 return False
|
igor@333
|
302
|
igor@333
|
303 oldname = base + '.out'
|
igor@333
|
304 tmpname = base + '.tmp'
|
igor@333
|
305 errname = base + '.err'
|
igor@333
|
306 errfp = open(errname, 'w+')
|
igor@333
|
307 for line in open(tmpname):
|
igor@333
|
308 errfp.write(mangle_re.sub('', line))
|
igor@333
|
309 os.rename(tmpname, base + '.lxo')
|
igor@333
|
310 errfp.seek(0)
|
igor@333
|
311 try:
|
igor@333
|
312 oldfp = open(oldname)
|
igor@333
|
313 except IOError, err:
|
igor@333
|
314 if err.errno != errno.ENOENT:
|
igor@333
|
315 raise
|
igor@333
|
316 os.rename(errname, oldname)
|
igor@333
|
317 return False
|
igor@333
|
318 if matchfp(oldfp, errfp):
|
igor@333
|
319 os.unlink(errname)
|
igor@333
|
320 return False
|
igor@333
|
321 else:
|
igor@333
|
322 print >> sys.stderr, '\nOutput of %s has changed!' % base
|
igor@333
|
323 os.system('diff -u %s %s 1>&2' % (oldname, errname))
|
igor@333
|
324 return True
|
igor@333
|
325
|
igor@333
|
326 def print_help(exit, msg=None):
|
igor@333
|
327 if msg:
|
igor@333
|
328 print >> sys.stderr, 'Error:', msg
|
igor@333
|
329 print >> sys.stderr, 'Usage: run-example [options] [test...]'
|
igor@333
|
330 print >> sys.stderr, 'Options:'
|
igor@333
|
331 print >> sys.stderr, ' -a --all run all tests in this directory'
|
igor@333
|
332 print >> sys.stderr, ' -h --help print this help message'
|
igor@333
|
333 print >> sys.stderr, ' -v --verbose display extra debug output'
|
igor@333
|
334 sys.exit(exit)
|
igor@333
|
335
|
igor@333
|
336 def main(path='.'):
|
igor@333
|
337 opts, args = getopt.getopt(sys.argv[1:], '?ahv',
|
igor@333
|
338 ['all', 'help', 'verbose'])
|
igor@333
|
339 verbose = False
|
igor@333
|
340 run_all = False
|
igor@333
|
341 for o, a in opts:
|
igor@333
|
342 if o in ('-h', '-?', '--help'):
|
igor@333
|
343 print_help(0)
|
igor@333
|
344 if o in ('-a', '--all'):
|
igor@333
|
345 run_all = True
|
igor@333
|
346 if o in ('-v', '--verbose'):
|
igor@333
|
347 verbose = True
|
igor@333
|
348 errs = 0
|
igor@333
|
349 if args:
|
igor@333
|
350 for a in args:
|
igor@333
|
351 try:
|
igor@333
|
352 st = os.lstat(a)
|
igor@333
|
353 except OSError, err:
|
igor@333
|
354 print >> sys.stderr, '%s: %s' % (a, err.strerror)
|
igor@333
|
355 errs += 1
|
igor@333
|
356 continue
|
igor@333
|
357 if stat.S_ISREG(st.st_mode) and st.st_mode & 0111:
|
igor@333
|
358 if example(a, verbose).run():
|
igor@333
|
359 errs += 1
|
igor@333
|
360 else:
|
igor@333
|
361 print >> sys.stderr, '%s: not a file, or not executable' % a
|
igor@333
|
362 errs += 1
|
igor@333
|
363 elif run_all:
|
igor@333
|
364 names = os.listdir(path)
|
igor@333
|
365 names.sort()
|
igor@333
|
366 for name in names:
|
igor@333
|
367 if name == 'run-example' or name.startswith('.'): continue
|
igor@333
|
368 if name.endswith('.out') or name.endswith('~'): continue
|
igor@333
|
369 if name.endswith('.run'): continue
|
igor@333
|
370 pathname = os.path.join(path, name)
|
igor@333
|
371 try:
|
igor@333
|
372 st = os.lstat(pathname)
|
igor@333
|
373 except OSError, err:
|
igor@333
|
374 # could be an output file that was removed while we ran
|
igor@333
|
375 if err.errno != errno.ENOENT:
|
igor@333
|
376 raise
|
igor@333
|
377 continue
|
igor@333
|
378 if stat.S_ISREG(st.st_mode) and st.st_mode & 0111:
|
igor@333
|
379 if example(pathname, verbose).run():
|
igor@333
|
380 errs += 1
|
igor@333
|
381 print >> open(os.path.join(path, '.run'), 'w'), time.asctime()
|
igor@333
|
382 else:
|
igor@333
|
383 print_help(1, msg='no test names given, and --all not provided')
|
igor@333
|
384 return errs
|
igor@333
|
385
|
igor@333
|
386 if __name__ == '__main__':
|
igor@333
|
387 try:
|
igor@333
|
388 sys.exit(main())
|
igor@333
|
389 except KeyboardInterrupt:
|
igor@333
|
390 print >> sys.stderr, 'interrupted!'
|
igor@333
|
391 sys.exit(1)
|