hgbook

annotate en/examples/run-example @ 71:ddf533d41c09

find changesets by author, revision, files, or words in the commit message
Propagate errors correctly.
author Bryan O'Sullivan <bos@serpentine.com>
date Tue Aug 29 22:25:18 2006 -0700 (2006-08-29)
parents 365b41b6a15e
children 12df31afb4e1
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@3 8 import os
bos@3 9 import pty
bos@3 10 import re
bos@4 11 import shutil
bos@6 12 import signal
bos@36 13 import stat
bos@3 14 import sys
bos@4 15 import tempfile
bos@4 16 import time
bos@3 17
bos@4 18 def tex_escape(s):
bos@4 19 if '\\' in s:
bos@4 20 s = s.replace('\\', '\\\\')
bos@4 21 if '{' in s:
bos@4 22 s = s.replace('{', '\\{')
bos@4 23 if '}' in s:
bos@4 24 s = s.replace('}', '\\}')
bos@4 25 return s
bos@4 26
bos@3 27 class example:
bos@70 28 shell = '/usr/bin/env bash'
bos@6 29 prompt = '__run_example_prompt__\n'
bos@71 30 pi_re = re.compile(r'#\$\s*(name):\s*(.*)$')
bos@4 31
bos@3 32 def __init__(self, name):
bos@3 33 self.name = name
bos@3 34
bos@3 35 def parse(self):
bos@4 36 '''yield each hunk of input from the file.'''
bos@3 37 fp = open(self.name)
bos@3 38 cfp = cStringIO.StringIO()
bos@3 39 for line in fp:
bos@3 40 cfp.write(line)
bos@3 41 if not line.rstrip().endswith('\\'):
bos@3 42 yield cfp.getvalue()
bos@3 43 cfp.seek(0)
bos@3 44 cfp.truncate()
bos@3 45
bos@3 46 def status(self, s):
bos@3 47 sys.stdout.write(s)
bos@3 48 if not s.endswith('\n'):
bos@3 49 sys.stdout.flush()
bos@3 50
bos@6 51 def send(self, s):
bos@6 52 self.cfp.write(s)
bos@6 53 self.cfp.flush()
bos@6 54
bos@6 55 def receive(self):
bos@6 56 out = cStringIO.StringIO()
bos@4 57 while True:
bos@6 58 s = self.cfp.readline().replace('\r\n', '\n')
bos@6 59 if not s or s == self.prompt:
bos@6 60 break
bos@6 61 out.write(s)
bos@6 62 return out.getvalue()
bos@4 63
bos@6 64 def sendreceive(self, s):
bos@6 65 self.send(s)
bos@6 66 r = self.receive()
bos@6 67 if r.startswith(s):
bos@6 68 r = r[len(s):]
bos@6 69 return r
bos@6 70
bos@3 71 def run(self):
bos@3 72 ofp = None
bos@4 73 basename = os.path.basename(self.name)
bos@4 74 self.status('running %s ' % basename)
bos@4 75 tmpdir = tempfile.mkdtemp(prefix=basename)
bos@6 76 rcfile = os.path.join(tmpdir, '.bashrc')
bos@6 77 rcfp = open(rcfile, 'w')
bos@6 78 print >> rcfp, 'PS1="%s"' % self.prompt
bos@6 79 print >> rcfp, 'unset HISTFILE'
bos@19 80 print >> rcfp, 'export EXAMPLE_DIR="%s"' % os.getcwd()
bos@6 81 print >> rcfp, 'export LANG=C'
bos@6 82 print >> rcfp, 'export LC_ALL=C'
bos@6 83 print >> rcfp, 'export TZ=GMT'
bos@6 84 print >> rcfp, 'export HGRC="%s/.hgrc"' % tmpdir
bos@6 85 print >> rcfp, 'export HGRCPATH=$HGRC'
bos@6 86 print >> rcfp, 'cd %s' % tmpdir
bos@6 87 rcfp.close()
bos@68 88 sys.stdout.flush()
bos@68 89 sys.stderr.flush()
bos@6 90 pid, fd = pty.fork()
bos@6 91 if pid == 0:
bos@70 92 cmdline = ['/usr/bin/env', 'bash', '--noediting', '--noprofile',
bos@70 93 '--norc']
bos@68 94 try:
bos@68 95 os.execv(cmdline[0], cmdline)
bos@68 96 except OSError, err:
bos@68 97 print >> sys.stderr, '%s: %s' % (cmdline[0], err.strerror)
bos@68 98 sys.stderr.flush()
bos@68 99 os._exit(0)
bos@6 100 self.cfp = os.fdopen(fd, 'w+')
bos@4 101 try:
bos@71 102 clean_exit = True
bos@71 103 try:
bos@71 104 # setup env and prompt
bos@71 105 self.sendreceive('source %s\n\n' % rcfile)
bos@71 106 for hunk in self.parse():
bos@71 107 # is this line a processing instruction?
bos@71 108 m = self.pi_re.match(hunk)
bos@71 109 if m:
bos@71 110 pi, rest = m.groups()
bos@71 111 if pi == 'name':
bos@71 112 self.status('.')
bos@71 113 out = rest
bos@71 114 assert os.sep not in out
bos@71 115 if out:
bos@71 116 ofp = open('%s.%s.out' % (self.name, out), 'w')
bos@71 117 else:
bos@71 118 ofp = None
bos@71 119 elif hunk.strip():
bos@71 120 # it's something we should execute
bos@71 121 output = self.sendreceive(hunk)
bos@71 122 if not ofp:
bos@71 123 continue
bos@71 124 # first, print the command we ran
bos@71 125 if not hunk.startswith('#'):
bos@71 126 nl = hunk.endswith('\n')
bos@71 127 hunk = ('$ \\textbf{%s}' %
bos@71 128 tex_escape(hunk.rstrip('\n')))
bos@71 129 if nl: hunk += '\n'
bos@71 130 ofp.write(hunk)
bos@71 131 # then its output
bos@71 132 ofp.write(tex_escape(output))
bos@71 133 self.status('\n')
bos@71 134 open(self.name + '.run', 'w')
bos@71 135 except:
bos@71 136 clean_exit = False
bos@71 137 raise
bos@4 138 finally:
bos@71 139 if clean_exit:
bos@71 140 try:
bos@71 141 output = self.sendreceive('exit\n')
bos@71 142 if ofp:
bos@71 143 ofp.write(output)
bos@71 144 self.cfp.close()
bos@71 145 except IOError:
bos@71 146 pass
bos@6 147 os.kill(pid, signal.SIGTERM)
bos@71 148 time.sleep(0.1)
bos@71 149 os.kill(pid, signal.SIGKILL)
bos@71 150 pid, rc = os.wait()
bos@71 151 if rc:
bos@71 152 if os.WIFEXITED(rc):
bos@71 153 print >> sys.stderr, '(exit %s)' % os.WEXITSTATUS(rc)
bos@71 154 elif os.WIFSIGNALED(rc):
bos@71 155 print >> sys.stderr, '(signal %s)' % os.WTERMSIG(rc)
bos@4 156 shutil.rmtree(tmpdir)
bos@71 157 return rc
bos@3 158
bos@3 159 def main(path='.'):
bos@3 160 args = sys.argv[1:]
bos@71 161 errs = 0
bos@3 162 if args:
bos@3 163 for a in args:
bos@71 164 if example(a).run():
bos@71 165 errs += 1
bos@71 166 return errs
bos@3 167 for name in os.listdir(path):
bos@3 168 if name == 'run-example' or name.startswith('.'): continue
bos@3 169 if name.endswith('.out') or name.endswith('~'): continue
bos@45 170 if name.endswith('.run'): continue
bos@19 171 pathname = os.path.join(path, name)
bos@36 172 st = os.lstat(pathname)
bos@36 173 if stat.S_ISREG(st.st_mode) and st.st_mode & 0111:
bos@71 174 if example(pathname).run():
bos@71 175 errs += 1
bos@4 176 print >> open(os.path.join(path, '.run'), 'w'), time.asctime()
bos@71 177 return errs
bos@3 178
bos@3 179 if __name__ == '__main__':
bos@71 180 sys.exit(main())