78160af8ba21afcbe7804a2dd75bf05b39321cbb
[ira/wip.git] / script / land.py
1 #!/usr/bin/env python
2 # run tests on all Samba subprojects and push to a git tree on success
3 # Copyright Andrew Tridgell 2010
4 # Copyright Jelmer Vernooij 2010
5 # released under GNU GPL v3 or later
6
7 from subprocess import call, check_call,Popen, PIPE
8 import os, tarfile, sys, time
9 from optparse import OptionParser
10 import smtplib
11 from email.mime.text import MIMEText
12
13 samba_master = os.getenv('SAMBA_MASTER', 'git://git.samba.org/samba.git')
14 samba_master_ssh = os.getenv('SAMBA_MASTER_SSH', 'git+ssh://git.samba.org/data/git/samba.git')
15
16 cleanup_list = []
17
18 os.putenv('CC', "ccache gcc")
19
20 tasks = {
21     "source3" : [ ("autogen", "./autogen.sh", "text/plain"),
22                   ("configure", "./configure.developer ${PREFIX}", "text/plain"),
23                   ("make basics", "make basics", "text/plain"),
24                   ("make", "make -j 4 everything", "text/plain"), # don't use too many processes
25                   ("install", "make install", "text/plain"),
26                   ("test", "TDB_NO_FSYNC=1 make subunit-test FAIL_IMMEDIATELY=1", "text/x-subunit") ],
27
28     "source4" : [ ("configure", "./configure.developer ${PREFIX}", "text/plain"),
29                   ("make", "make -j", "text/plain"),
30                   ("install", "make install", "text/plain"),
31                   ("test", "TDB_NO_FSYNC=1 make subunit-test FAIL_IMMEDIATELY=1", "text/x-subunit") ],
32
33     "source4/lib/ldb" : [ ("configure", "./configure --enable-developer -C ${PREFIX}", "text/plain"),
34                           ("make", "make -j", "text/plain"),
35                           ("install", "make install", "text/plain"),
36                           ("test", "make test", "text/plain") ],
37
38     "lib/tdb" : [ ("autogen", "./autogen-waf.sh", "text/plain"),
39                   ("configure", "./configure --enable-developer -C ${PREFIX}", "text/plain"),
40                   ("make", "make -j", "text/plain"),
41                   ("install", "make install", "text/plain"),
42                   ("test", "make test", "text/plain") ],
43
44     "lib/talloc" : [ ("autogen", "./autogen-waf.sh", "text/plain"),
45                      ("configure", "./configure --enable-developer -C ${PREFIX}", "text/plain"),
46                      ("make", "make -j", "text/plain"),
47                      ("install", "make install", "text/plain"),
48                      ("test", "make test", "text/plain"), ],
49
50     "lib/replace" : [ ("autogen", "./autogen-waf.sh", "text/plain"),
51                       ("configure", "./configure --enable-developer -C ${PREFIX}", "text/plain"),
52                       ("make", "make -j", "text/plain"),
53                       ("install", "make install", "text/plain"),
54                       ("test", "make test", "text/plain"), ],
55
56     "lib/tevent" : [ ("configure", "./configure --enable-developer -C ${PREFIX}", "text/plain"),
57                      ("make", "make -j", "text/plain"),
58                      ("install", "make install", "text/plain"),
59                      ("test", "make test", "text/plain"), ],
60 }
61
62 retry_task = [ ( "retry",
63                  '''set -e
64                 git remote add -t master master %s
65                 git fetch master
66                 while :; do
67                   sleep 60
68                   git describe master/master > old_master.desc
69                   git fetch master
70                   git describe master/master > master.desc
71                   diff old_master.desc master.desc
72                 done
73                ''' % samba_master, "test/plain" ) ]
74
75 def run_cmd(cmd, dir=".", show=None, output=False, checkfail=True):
76     if show is None:
77         show = options.verbose
78     if show:
79         print("Running: '%s' in '%s'" % (cmd, dir))
80     if output:
81         return Popen([cmd], shell=True, stdout=PIPE, cwd=dir).communicate()[0]
82     elif checkfail:
83         return check_call(cmd, shell=True, cwd=dir)
84     else:
85         return call(cmd, shell=True, cwd=dir)
86
87
88 class builder(object):
89     '''handle build of one directory'''
90
91     def __init__(self, name, sequence):
92         self.name = name
93
94         if name in ['pass', 'fail', 'retry']:
95             self.dir = "."
96         else:
97             self.dir = self.name
98
99         self.tag = self.name.replace('/', '_')
100         self.sequence = sequence
101         self.next = 0
102         self.stdout_path = "%s/%s.stdout" % (gitroot, self.tag)
103         self.stderr_path = "%s/%s.stderr" % (gitroot, self.tag)
104         if options.verbose:
105             print("stdout for %s in %s" % (self.name, self.stdout_path))
106             print("stderr for %s in %s" % (self.name, self.stderr_path))
107         run_cmd("rm -f %s %s" % (self.stdout_path, self.stderr_path))
108         self.stdout = open(self.stdout_path, 'w')
109         self.stderr = open(self.stderr_path, 'w')
110         self.stdin  = open("/dev/null", 'r')
111         self.sdir = "%s/%s" % (testbase, self.tag)
112         self.prefix = "%s/prefix/%s" % (testbase, self.tag)
113         run_cmd("rm -rf %s" % self.sdir)
114         cleanup_list.append(self.sdir)
115         cleanup_list.append(self.prefix)
116         os.makedirs(self.sdir)
117         run_cmd("rm -rf %s" % self.sdir)
118         run_cmd("git clone --shared %s %s" % (gitroot, self.sdir))
119         self.start_next()
120
121     def start_next(self):
122         if self.next == len(self.sequence):
123             print '%s: Completed OK' % self.name
124             self.done = True
125             return
126         (self.stage, self.cmd, self.output_mime_type) = self.sequence[self.next]
127         self.cmd = self.cmd.replace("${PREFIX}", "--prefix=%s" % self.prefix)
128         if self.output_mime_type == "text/x-subunit":
129             self.cmd += " | %s --immediate" % (os.path.join(os.path.dirname(__file__), "selftest/format-subunit"))
130         print '%s: [%s] Running %s' % (self.name, self.stage, self.cmd)
131         self.proc = Popen(self.cmd, shell=True, cwd="%s/%s" % (self.sdir, self.dir),
132                           stdout=self.stdout, stderr=self.stderr, stdin=self.stdin)
133         self.next += 1
134
135
136 class buildlist(object):
137     '''handle build of multiple directories'''
138
139     def __init__(self, tasklist, tasknames):
140         global tasks
141         self.tlist = []
142         self.tail_proc = None
143         self.retry = None
144         if tasknames == ['pass']:
145             tasks = { 'pass' : [ ("pass", '/bin/true', "text/plain") ]}
146         if tasknames == ['fail']:
147             tasks = { 'fail' : [ ("fail", '/bin/false', "text/plain") ]}
148         if tasknames == []:
149             tasknames = tasklist
150         for n in tasknames:
151             b = builder(n, tasks[n])
152             self.tlist.append(b)
153         if options.retry:
154             self.retry = builder('retry', retry_task)
155             self.need_retry = False
156
157     def kill_kids(self):
158         if self.tail_proc is not None:
159             self.tail_proc.terminate()
160             self.tail_proc.wait()
161             self.tail_proc = None
162         if self.retry is not None:
163             self.retry.proc.terminate()
164             self.retry.proc.wait()
165             self.retry = None
166         for b in self.tlist:
167             if b.proc is not None:
168                 run_cmd("killbysubdir %s > /dev/null 2>&1" % b.sdir, checkfail=False)
169                 b.proc.terminate()
170                 b.proc.wait()
171                 b.proc = None
172
173     def wait_one(self):
174         while True:
175             none_running = True
176             for b in self.tlist:
177                 if b.proc is None:
178                     continue
179                 none_running = False
180                 b.status = b.proc.poll()
181                 if b.status is None:
182                     continue
183                 b.proc = None
184                 return b
185             if options.retry:
186                 ret = self.retry.proc.poll()
187                 if ret is not None:
188                     self.need_retry = True
189                     self.retry = None
190                     return None
191             if none_running:
192                 return None
193             time.sleep(0.1)
194
195     def run(self):
196         while True:
197             b = self.wait_one()
198             if options.retry and self.need_retry:
199                 self.kill_kids()
200                 print("retry needed")
201                 return (0, "retry")
202             if b is None:
203                 break
204             if os.WIFSIGNALED(b.status) or os.WEXITSTATUS(b.status) != 0:
205                 self.kill_kids()
206                 return (b.status, b.name, b.stage, b.tag, "%s: [%s] failed '%s' with status %d" % (b.name, b.stage, b.cmd, b.status))
207             b.start_next()
208         self.kill_kids()
209         return (0, None, None, None, "All OK")
210
211     def tarlogs(self, fname):
212         tar = tarfile.open(fname, "w:gz")
213         for b in self.tlist:
214             tar.add(b.stdout_path, arcname="%s.stdout" % b.tag)
215             tar.add(b.stderr_path, arcname="%s.stderr" % b.tag)
216         tar.close()
217
218     def remove_logs(self):
219         for b in self.tlist:
220             os.unlink(b.stdout_path)
221             os.unlink(b.stderr_path)
222
223     def start_tail(self):
224         cmd = "tail -f *.stdout *.stderr"
225         self.tail_proc = Popen(cmd, shell=True, cwd=gitroot)
226
227
228 def cleanup():
229     if options.nocleanup:
230         return
231     print("Cleaning up ....")
232     for d in cleanup_list:
233         run_cmd("rm -rf %s" % d)
234
235
236 def find_git_root():
237     '''get to the top of the git repo'''
238     p=os.getcwd()
239     while p != '/':
240         if os.path.isdir(os.path.join(p, ".git")):
241             return p
242         p = os.path.abspath(os.path.join(p, '..'))
243     return None
244
245
246 def daemonize(logfile):
247     pid = os.fork()
248     if pid == 0: # Parent
249         os.setsid()
250         pid = os.fork()
251         if pid != 0: # Actual daemon
252             os._exit(0)
253     else: # Grandparent
254         os._exit(0)
255
256     import resource      # Resource usage information.
257     maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
258     if maxfd == resource.RLIM_INFINITY:
259         maxfd = 1024 # Rough guess at maximum number of open file descriptors.
260     for fd in range(0, maxfd):
261         try:
262             os.close(fd)
263         except OSError:
264             pass
265     os.open(logfile, os.O_RDWR | os.O_CREAT)
266     os.dup2(0, 1)
267     os.dup2(0, 2)
268
269
270 def rebase_tree(url):
271     print("Rebasing on %s" % url)
272     run_cmd("git remote add -t master master %s" % url, show=True, dir=test_master)
273     run_cmd("git fetch master", show=True, dir=test_master)
274     if options.fix_whitespace:
275         run_cmd("git rebase --whitespace=fix master/master", show=True, dir=test_master)
276     else:
277         run_cmd("git rebase master/master", show=True, dir=test_master)
278     diff = run_cmd("git --no-pager diff HEAD master/master", dir=test_master, output=True)
279     if diff == '':
280         print("No differences between HEAD and master/master - exiting")
281         sys.exit(0)
282
283 def push_to(url):
284     print("Pushing to %s" % url)
285     if options.mark:
286         run_cmd("EDITOR=script/commit_mark.sh git commit --amend -c HEAD", dir=test_master)
287         # the notes method doesn't work yet, as metze hasn't allowed refs/notes/* in master
288         # run_cmd("EDITOR=script/commit_mark.sh git notes edit HEAD", dir=test_master)
289     run_cmd("git remote add -t master pushto %s" % url, show=True, dir=test_master)
290     run_cmd("git push pushto +HEAD:master", show=True, dir=test_master)
291
292 def_testbase = os.getenv("AUTOBUILD_TESTBASE", "/memdisk/%s" % os.getenv('USER'))
293
294 parser = OptionParser()
295 parser.add_option("", "--tail", help="show output while running", default=False, action="store_true")
296 parser.add_option("", "--keeplogs", help="keep logs", default=False, action="store_true")
297 parser.add_option("", "--nocleanup", help="don't remove test tree", default=False, action="store_true")
298 parser.add_option("", "--testbase", help="base directory to run tests in (default %s)" % def_testbase,
299                   default=def_testbase)
300 parser.add_option("", "--passcmd", help="command to run on success", default=None)
301 parser.add_option("", "--verbose", help="show all commands as they are run",
302                   default=False, action="store_true")
303 parser.add_option("", "--rebase", help="rebase on the given tree before testing",
304                   default=None, type='str')
305 parser.add_option("", "--rebase-master", help="rebase on %s before testing" % samba_master,
306                   default=False, action='store_true')
307 parser.add_option("", "--pushto", help="push to a git url on success",
308                   default=None, type='str')
309 parser.add_option("", "--push-master", help="push to %s on success" % samba_master_ssh,
310                   default=False, action='store_true')
311 parser.add_option("", "--mark", help="add a Tested-By signoff before pushing",
312                   default=False, action="store_true")
313 parser.add_option("", "--fix-whitespace", help="fix whitespace on rebase",
314                   default=False, action="store_true")
315 parser.add_option("", "--retry", help="automatically retry if master changes",
316                   default=False, action="store_true")
317 parser.add_option("", "--email", help="send email to the given address on failure",
318                   type='str', default=None)
319 parser.add_option("", "--always-email", help="always send email, even on success",
320                   action="store_true")
321 parser.add_option("", "--daemon", help="daemonize after initial setup",
322                   action="store_true")
323
324
325 def email_failure(status, failed_task, failed_stage, failed_tag, errstr):
326     '''send an email to options.email about the failure'''
327     user = os.getenv("USER")
328     text = '''
329 Dear Developer,
330
331 Your autobuild failed when trying to test %s with the following error:
332    %s
333
334 the autobuild has been abandoned. Please fix the error and resubmit.
335
336 You can see logs of the failed task here:
337
338   http://git.samba.org/%s/samba-autobuild/%s.stdout
339   http://git.samba.org/%s/samba-autobuild/%s.stderr
340
341 or you can get full logs of all tasks in this job here:
342
343   http://git.samba.org/%s/samba-autobuild/logs.tar.gz
344
345 ''' % (failed_task, errstr, user, failed_tag, user, failed_tag, user)
346     msg = MIMEText(text)
347     msg['Subject'] = 'autobuild failure for task %s during %s' % (failed_task, failed_stage)
348     msg['From'] = 'autobuild@samba.org'
349     msg['To'] = options.email
350
351     s = smtplib.SMTP()
352     s.connect()
353     s.sendmail(msg['From'], [msg['To']], msg.as_string())
354     s.quit()
355
356 def email_success():
357     '''send an email to options.email about a successful build'''
358     user = os.getenv("USER")
359     text = '''
360 Dear Developer,
361
362 Your autobuild has succeeded.
363
364 '''
365
366     if options.keeplogs:
367         text += '''
368
369 you can get full logs of all tasks in this job here:
370
371   http://git.samba.org/%s/samba-autobuild/logs.tar.gz
372
373 ''' % (user,)
374     msg = MIMEText(text)
375     msg['Subject'] = 'autobuild success'
376     msg['From'] = 'autobuild@samba.org'
377     msg['To'] = options.email
378
379     s = smtplib.SMTP()
380     s.connect()
381     s.sendmail(msg['From'], [msg['To']], msg.as_string())
382     s.quit()
383
384
385 (options, args) = parser.parse_args()
386
387 if options.retry:
388     if not options.rebase_master and options.rebase is None:
389         raise Exception('You can only use --retry if you also rebase')
390
391 testbase = "%s/b%u" % (options.testbase, os.getpid())
392 test_master = "%s/master" % testbase
393
394 gitroot = find_git_root()
395 if gitroot is None:
396     raise Exception("Failed to find git root")
397
398 try:
399     os.makedirs(testbase)
400 except Exception, reason:
401     raise Exception("Unable to create %s : %s" % (testbase, reason))
402 cleanup_list.append(testbase)
403
404 if options.daemon:
405     logfile = os.path.join(testbase, "log")
406     print "Forking into the background, writing progress to %s" % logfile
407     daemonize(logfile)
408
409 while True:
410     try:
411         run_cmd("rm -rf %s" % test_master)
412         cleanup_list.append(test_master)
413         run_cmd("git clone --shared %s %s" % (gitroot, test_master))
414     except:
415         cleanup()
416         raise
417
418     try:
419         if options.rebase is not None:
420             rebase_tree(options.rebase)
421         elif options.rebase_master:
422             rebase_tree(samba_master)
423         blist = buildlist(tasks, args)
424         if options.tail:
425             blist.start_tail()
426         (status, failed_task, failed_stage, failed_tag, errstr) = blist.run()
427         if status != 0 or errstr != "retry":
428             break
429         cleanup()
430     except:
431         cleanup()
432         raise
433
434 blist.kill_kids()
435 if options.tail:
436     print("waiting for tail to flush")
437     time.sleep(1)
438
439 if status == 0:
440     print errstr
441     if options.passcmd is not None:
442         print("Running passcmd: %s" % options.passcmd)
443         run_cmd(options.passcmd, dir=test_master)
444     if options.pushto is not None:
445         push_to(options.pushto)
446     elif options.push_master:
447         push_to(samba_master_ssh)
448     if options.keeplogs:
449         blist.tarlogs("logs.tar.gz")
450         print("Logs in logs.tar.gz")
451     if options.always_email:
452         email_success()
453     blist.remove_logs()
454     cleanup()
455     print(errstr)
456     sys.exit(0)
457
458 # something failed, gather a tar of the logs
459 blist.tarlogs("logs.tar.gz")
460
461 if options.email is not None:
462     email_failure(status, failed_task, failed_stage, failed_tag, errstr)
463
464 cleanup()
465 print(errstr)
466 print("Logs in logs.tar.gz")
467 sys.exit(status)