hgbook

annotate en/examples/run-example @ 465:aa6036a9688e

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