blob: 94b496d5536235dcbe9dd1baa10fea0d03ba9b8e [file] [log] [blame]
Neal Norwitz461aa5b2006-01-02 20:07:16 +00001#!/bin/sh
2
3## Script to build and test the latest python from svn. It basically
4## does this:
5## svn up ; ./configure ; make ; make test ; make install ; cd Doc ; make
6##
7## Logs are kept and rsync'ed to the host. If there are test failure(s),
8## information about the failure(s) is mailed.
9##
10## This script is run on the PSF's machine as user neal via crontab.
11##
12## Yes, this script would probably be easier in python, but then
13## there's a bootstrap problem. What if Python doesn't build?
14##
15## This script should be fairly clean Bourne shell, ie not too many
16## bash-isms. We should try to keep it portable to other Unixes.
17## Even though it will probably only run on Linux. I'm sure there are
18## several GNU-isms currently (date +%s and readlink).
19##
20## Perhaps this script should be broken up into 2 (or more) components.
21## Building doc is orthogonal to the rest of the python build/test.
22##
23
24## FIXME: we should detect test hangs (eg, if they take more than 45 minutes)
25
26## FIXME: we should run valgrind
27## FIXME: we should run code coverage
28
29## Utilities invoked in this script include:
Neal Norwitzd3a58672006-01-02 23:22:41 +000030## basename, date, dirname, expr, grep, readlink, uname
Neal Norwitz461aa5b2006-01-02 20:07:16 +000031## cksum, make, mutt, rsync, svn
32
Neal Norwitz461aa5b2006-01-02 20:07:16 +000033## remember where did we started from
34DIR=`dirname $0`
35if [ "$DIR" = "" ]; then
36 DIR="."
37fi
38
39## make directory absolute
40DIR=`readlink -f $DIR`
Neal Norwitzd3a58672006-01-02 23:22:41 +000041FULLPATHNAME="$DIR/`basename $0`"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000042## we want Misc/..
43DIR=`dirname $DIR`
44
45## Configurable options
46
47FAILURE_SUBJECT="Python Regression Test Failures"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000048#FAILURE_MAILTO="YOUR_ACCOUNT@gmail.com"
Guido van Rossum52056532007-05-10 14:04:07 +000049FAILURE_MAILTO="python-3000-checkins@python.org"
Guido van Rossumd8faa362007-04-27 19:54:29 +000050#FAILURE_CC="optional--uncomment and set to desired address"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000051
52REMOTE_SYSTEM="neal@dinsdale.python.org"
Guido van Rossum52056532007-05-10 14:04:07 +000053REMOTE_DIR="/data/ftp.python.org/pub/docs.python.org/dev/3.0"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000054RESULT_FILE="$DIR/build/index.html"
Guido van Rossum52056532007-05-10 14:04:07 +000055INSTALL_DIR="/tmp/python-test-3.0/local"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000056RSYNC_OPTS="-aC -e ssh"
57
Thomas Wouters0e3f5912006-08-11 14:57:12 +000058# Always run the installed version of Python.
59PYTHON=$INSTALL_DIR/bin/python
60
61# Python options and regression test program that should always be run.
Guido van Rossum52056532007-05-10 14:04:07 +000062REGRTEST_ARGS="-E -tt $INSTALL_DIR/lib/python3.0/test/regrtest.py"
Thomas Wouters0e3f5912006-08-11 14:57:12 +000063
Neal Norwitz461aa5b2006-01-02 20:07:16 +000064REFLOG="build/reflog.txt.out"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000065# These tests are not stable and falsely report leaks sometimes.
Neal Norwitzf415d5f2006-02-19 18:48:19 +000066# The entire leak report will be mailed if any test not in this list leaks.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000067# Note: test_XXX (none currently) really leak, but are disabled
68# so we don't send spam. Any test which really leaks should only
69# be listed here if there are also test cases under Lib/test/leakers.
Guido van Rossum7eaf8222007-06-18 17:58:50 +000070LEAKY_TESTS="test_(cmd_line|popen2|socket|threading_local|urllib2_localnet)"
Guido van Rossum52056532007-05-10 14:04:07 +000071
72# These tests always fail, so skip them so we don't get false positives.
Guido van Rossumcd16bf62007-06-13 18:07:49 +000073_ALWAYS_SKIP=""
Guido van Rossum52056532007-05-10 14:04:07 +000074ALWAYS_SKIP="-x $_ALWAYS_SKIP"
Neal Norwitzf415d5f2006-02-19 18:48:19 +000075
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000076# Skip these tests altogether when looking for leaks. These tests
77# do not need to be stored above in LEAKY_TESTS too.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078# test_logging causes hangs, skip it.
Neal Norwitzcb44f262007-08-16 05:15:20 +000079LEAKY_SKIPS="-x test_logging $_ALWAYS_SKIP"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000080
81# Change this flag to "yes" for old releases to only update/build the docs.
Neal Norwitz88b78d82006-02-14 08:14:16 +000082BUILD_DISABLED="no"
Neal Norwitz461aa5b2006-01-02 20:07:16 +000083
84## utility functions
85current_time() {
86 date +%s
87}
88
89update_status() {
90 now=`current_time`
91 time=`expr $now - $3`
92 echo "<li><a href=\"$2\">$1</a> <font size=\"-1\">($time seconds)</font></li>" >> $RESULT_FILE
93}
94
95mail_on_failure() {
96 if [ "$NUM_FAILURES" != "0" ]; then
Guido van Rossumd8faa362007-04-27 19:54:29 +000097 dest=$FAILURE_MAILTO
98 # FAILURE_CC is optional.
99 if [ "$FAILURE_CC" != "" ]; then
100 dest="$dest -c $FAILURE_CC"
101 fi
102 mutt -s "$FAILURE_SUBJECT $1 ($NUM_FAILURES)" $dest < $2
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000103 fi
104}
105
106## setup
107cd $DIR
108mkdir -p build
109rm -f $RESULT_FILE build/*.out
110rm -rf $INSTALL_DIR
111
112## create results file
113TITLE="Automated Python Build Results"
Neal Norwitzb8967592006-01-16 04:37:22 +0000114echo "<html>" >> $RESULT_FILE
115echo " <head>" >> $RESULT_FILE
116echo " <title>$TITLE</title>" >> $RESULT_FILE
117echo " <meta http-equiv=\"refresh\" content=\"43200\">" >> $RESULT_FILE
118echo " </head>" >> $RESULT_FILE
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000119echo "<body>" >> $RESULT_FILE
120echo "<h2>Automated Python Build Results</h2>" >> $RESULT_FILE
121echo "<table>" >> $RESULT_FILE
122echo " <tr>" >> $RESULT_FILE
123echo " <td>Built on:</td><td>`date`</td>" >> $RESULT_FILE
124echo " </tr><tr>" >> $RESULT_FILE
125echo " <td>Hostname:</td><td>`uname -n`</td>" >> $RESULT_FILE
126echo " </tr><tr>" >> $RESULT_FILE
127echo " <td>Platform:</td><td>`uname -srmpo`</td>" >> $RESULT_FILE
128echo " </tr>" >> $RESULT_FILE
129echo "</table>" >> $RESULT_FILE
130echo "<ul>" >> $RESULT_FILE
131
132## update, build, and test
133ORIG_CHECKSUM=`cksum $FULLPATHNAME`
134F=svn-update.out
135start=`current_time`
136svn update >& build/$F
137err=$?
138update_status "Updating" "$F" $start
Neal Norwitz88b78d82006-02-14 08:14:16 +0000139if [ $err = 0 -a "$BUILD_DISABLED" != "yes" ]; then
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000140 ## FIXME: we should check if this file has changed.
141 ## If it has changed, we should re-run the script to pick up changes.
142 if [ "$ORIG_CHECKSUM" != "$ORIG_CHECKSUM" ]; then
143 exec $FULLPATHNAME $@
144 fi
145
146 F=svn-stat.out
147 start=`current_time`
148 svn stat >& build/$F
149 ## ignore some of the diffs
150 NUM_DIFFS=`egrep -vc '^. (@test|db_home|Lib/test/(regrtest\.py|db_home))$' build/$F`
151 update_status "svn stat ($NUM_DIFFS possibly important diffs)" "$F" $start
152
153 F=configure.out
154 start=`current_time`
155 ./configure --prefix=$INSTALL_DIR --with-pydebug >& build/$F
156 err=$?
157 update_status "Configuring" "$F" $start
158 if [ $err = 0 ]; then
159 F=make.out
160 start=`current_time`
161 make >& build/$F
162 err=$?
163 warnings=`grep warning build/$F | egrep -vc "te?mpnam(_r|)' is dangerous,"`
164 update_status "Building ($warnings warnings)" "$F" $start
165 if [ $err = 0 ]; then
Neal Norwitzd19a4d42006-01-02 22:10:10 +0000166 ## make install
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000167 F=make-install.out
168 start=`current_time`
169 make install >& build/$F
170 update_status "Installing" "$F" $start
171
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000172 if [ ! -x $PYTHON ]; then
Guido van Rossum52056532007-05-10 14:04:07 +0000173 ln -s ${PYTHON}3.* $PYTHON
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000174 fi
175
Neal Norwitzd19a4d42006-01-02 22:10:10 +0000176 ## make and run basic tests
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000177 F=make-test.out
178 start=`current_time`
Guido van Rossum52056532007-05-10 14:04:07 +0000179 $PYTHON $REGRTEST_ARGS $ALWAYS_SKIP >& build/$F
Neal Norwitz79415522006-02-15 06:07:32 +0000180 NUM_FAILURES=`grep -ic " failed:" build/$F`
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000181 update_status "Testing basics ($NUM_FAILURES failures)" "$F" $start
Neal Norwitz02c408d2006-01-03 02:18:01 +0000182 mail_on_failure "basics" build/$F
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000183
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000184 F=make-test-opt.out
185 start=`current_time`
Guido van Rossum52056532007-05-10 14:04:07 +0000186 $PYTHON -O $REGRTEST_ARGS $ALWAYS_SKIP >& build/$F
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000187 NUM_FAILURES=`grep -ic " failed:" build/$F`
188 update_status "Testing opt ($NUM_FAILURES failures)" "$F" $start
189 mail_on_failure "opt" build/$F
190
Neal Norwitzd19a4d42006-01-02 22:10:10 +0000191 ## run the tests looking for leaks
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000192 F=make-test-refleak.out
193 start=`current_time`
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000194 ## ensure that the reflog exists so the grep doesn't fail
195 touch $REFLOG
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 $PYTHON $REGRTEST_ARGS -R 4:3:$REFLOG -u network $LEAKY_SKIPS >& build/$F
Guido van Rossum360e4b82007-05-14 22:51:27 +0000197 NUM_FAILURES=`egrep -vc "($LEAKY_TESTS|sum=0)" $REFLOG`
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000198 update_status "Testing refleaks ($NUM_FAILURES failures)" "$F" $start
199 mail_on_failure "refleak" $REFLOG
200
Neal Norwitzd19a4d42006-01-02 22:10:10 +0000201 ## now try to run all the tests
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000202 F=make-testall.out
203 start=`current_time`
Neal Norwitzd19a4d42006-01-02 22:10:10 +0000204 ## skip curses when running from cron since there's no terminal
205 ## skip sound since it's not setup on the PSF box (/dev/dsp)
Guido van Rossum52056532007-05-10 14:04:07 +0000206 $PYTHON $REGRTEST_ARGS -uall -x test_curses test_linuxaudiodev test_ossaudiodev $_ALWAYS_SKIP >& build/$F
Neal Norwitz79415522006-02-15 06:07:32 +0000207 NUM_FAILURES=`grep -ic " failed:" build/$F`
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000208 update_status "Testing all except curses and sound ($NUM_FAILURES failures)" "$F" $start
Neal Norwitzd3a58672006-01-02 23:22:41 +0000209 mail_on_failure "all" build/$F
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000210 fi
211 fi
212fi
213
214
215## make doc
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000216cd $DIR/Doc
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000217F="make-doc.out"
218start=`current_time`
Neal Norwitzcb44f262007-08-16 05:15:20 +0000219# XXX(nnorwitz): For now, keep the code that checks for a conflicted file until
220# after the first release of 2.6a1 or 3.0a1. At that point, it will be clear
221# if there will be a similar problem with the new doc system.
222
Guido van Rossumd8faa362007-04-27 19:54:29 +0000223# Doc/commontex/boilerplate.tex is expected to always have an outstanding
224# modification for the date. When a release is cut, a conflict occurs.
225# This allows us to detect this problem and not try to build the docs
226# which will definitely fail with a conflict.
Neal Norwitzcb44f262007-08-16 05:15:20 +0000227#CONFLICTED_FILE=commontex/boilerplate.tex
228#conflict_count=`grep -c "<<<" $CONFLICTED_FILE`
229conflict_count=0
Guido van Rossumd8faa362007-04-27 19:54:29 +0000230if [ $conflict_count != 0 ]; then
231 echo "Conflict detected in $CONFLICTED_FILE. Doc build skipped." > ../build/$F
232 err=1
233else
Neal Norwitzed44a1a2007-08-17 04:19:37 +0000234 make update html >& ../build/$F
Guido van Rossumd8faa362007-04-27 19:54:29 +0000235 err=$?
236fi
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000237update_status "Making doc" "$F" $start
238if [ $err != 0 ]; then
239 NUM_FAILURES=1
240 mail_on_failure "doc" ../build/$F
241fi
242
243echo "</ul>" >> $RESULT_FILE
244echo "</body>" >> $RESULT_FILE
245echo "</html>" >> $RESULT_FILE
246
247## copy results
Neal Norwitzcb44f262007-08-16 05:15:20 +0000248rsync $RSYNC_OPTS build/html/* $REMOTE_SYSTEM:$REMOTE_DIR
Neal Norwitz461aa5b2006-01-02 20:07:16 +0000249cd ../build
250rsync $RSYNC_OPTS index.html *.out $REMOTE_SYSTEM:$REMOTE_DIR/results/