pintos-os.org Git - pspp/blob - build-pspp

   1 #! /usr/bin/env perl
   2
   3 use Cwd;
   4 use File::Spec;
   5 use Getopt::Long qw(:config bundling no_ignore_case);
   6 use IO::Handle;
   7 use POSIX;
   8
   9 use strict;
  10 use warnings;
  11
  12 my $help = 0;
  13 my $build_binary = 1;
  14 my $batch = 0;
  15 my $builddir;
  16 my $build_number;
  17 GetOptions ("h|help" => \$help,
  18             "binary!" => \$build_binary,
  19             "batch!" => \$batch,
  20             "o|output=s" => \$builddir,
  21             "build-number=i" => \$build_number);
  22
  23 usage () if $help;
  24
  25 die "$0: exactly one or two nonoption arguments are required\n"
  26   if @ARGV != 1 && @ARGV != 2;
  27
  28 # Select build number.
  29 if (!defined ($build_number)) {
  30     $build_number = POSIX::strftime("%Y%m%d%H%M%S", localtime);
  31 }
  32
  33 my $topdir = getcwd ();
  34
  35 # Create build directory.
  36 if (!defined ($builddir)) {
  37     $builddir = "builds/$build_number";
  38     mkdir "builds" or die "builds: mkdir: $!\n" if ! -d "builds";
  39 }
  40 -d $builddir or mkdir $builddir or die "$builddir: mkdir: $!\n";
  41 my $abs_builddir = File::Spec->rel2abs ($builddir);
  42
  43 our $resultsdir = "$builddir/results";
  44 mkdir $resultsdir or die "$resultsdir: mkdir: $!\n";
  45 mkdir "$resultsdir/vars" or die "$resultsdir/vars: mkdir: $!\n";
  46 my $abs_resultsdir = File::Spec->rel2abs ($resultsdir);
  47
  48 my $varsfile = "$resultsdir/VARS";
  49 open (VARS, '>', $varsfile) or die "creating $varsfile failed: $!\n";
  50 VARS->autoflush (1);
  51
  52 my $logfile = "$resultsdir/LOG";
  53 open (LOG, '>', $logfile) or die "creating $logfile failed: $!\n";
  54
  55 my $build_host = `hostname`;
  56 chomp $build_host;
  57 set_var ("build_host", $build_host);
  58 set_var ("build_number", $build_number);
  59
  60 sub start_step {
  61     my ($msg) = @_;
  62     print LOG "\f\n$msg\n";
  63     print "$msg\n" unless $batch;
  64 }
  65
  66 sub set_var {
  67     my ($var, $value) = @_;
  68
  69     print VARS "$var=$value\n";
  70
  71     print "\t$var=$value\n" unless $batch;
  72
  73     open (VAR, '>', "$resultsdir/vars/$var")
  74       or die "creating $resultsdir/$var failed: $!\n";
  75     print VAR "$value\n";
  76     close VAR;
  77 }
  78
  79 sub saved_result {
  80     my ($name, $product) = @_;
  81     start_step ("Saving $name: $product");
  82 }
  83
  84 sub save_result {
  85     my ($name, $src, $rm_src) = @_;
  86     my ($basename) = $src;
  87     $basename =~ s(^.*/)();
  88     my ($dst) = "$resultsdir/$basename";
  89
  90     saved_result ($name, $basename);
  91     run ("cp -R $src $dst");
  92
  93     if (defined ($rm_src) && $rm_src) {
  94         run ("rm $src");
  95     }
  96
  97     return $dst;
  98 }
  99
 100 sub save_result_if_exists {
 101     my ($name, $src, $rm_src) = @_;
 102     if (-e $src) {
 103         save_result (@_);
 104     } else {
 105         start_step ("$src does not exist, cannot save");
 106     }
 107 }
 108
 109 my $tarball;
 110 if (@ARGV == 2) {
 111     my ($repo, $branch) = @ARGV;
 112
 113     # Fetch branch
 114     start_step ("Fetch $repo, branch $branch");
 115     run ("git fetch $repo +$branch:buildtmp/$$/pspp");
 116
 117     # Get revision number.
 118     my $revision = `git rev-parse buildtmp/$$/pspp`;
 119     chomp $revision;
 120     set_var ("pspp_commit", $revision);
 121     my $abbrev_commit = substr ($revision, 0, 6);
 122
 123     # Extract source.
 124     start_step ("Extract branch into $builddir/pspp$build_number");
 125     run ("git archive --format=tar --prefix=pspp$build_number/ buildtmp/$$/pspp | (cd $builddir && tar xf -)");
 126     run ("git branch -D buildtmp/$$/pspp");
 127
 128     # Extract version number.
 129     start_step ("Extract repository version number");
 130     my $trace = `cd $builddir/pspp$build_number && autoconf -t AC_INIT`;
 131     chomp $trace;
 132     my ($file, $line, $macro, $package, $repo_version, @rest)
 133       = split (':', $trace);
 134     set_var ("repo_version", $repo_version);
 135
 136     # Is this a "gnits" mode tree?
 137     start_step ("Checking Automake mode");
 138     open (MAKEFILE_AM, '<', "$builddir/pspp$build_number/Makefile.am");
 139     my $am_mode = "gnu";
 140     while (<MAKEFILE_AM>) {
 141         if (/gnits/) {
 142             $am_mode = "gnits";
 143             last;
 144         }
 145     }
 146     close (MAKEFILE_AM);
 147     set_var ("am_mode", $am_mode);
 148
 149     # Generate version number for build.
 150     # We want to append -g012345, but if we're in Gnits mode and the
 151     # version number already has a hyphen, we have to omit it.
 152     start_step ("Generate build version number");
 153     my $version = $repo_version;
 154     $version .= '-' unless $version =~ /-/;
 155     $version .= "g$abbrev_commit";
 156     set_var ("version", $version);
 157
 158     # Append -g012345 to configure.ac version number.
 159     start_step ("Updating version number in $file");
 160     my $fullname = "$builddir/pspp$build_number/$file";
 161     open (OLDFILE, '<', $fullname)
 162       or die "opening $fullname failed: $!\n";
 163     open (NEWFILE, '>', "$fullname.new")
 164       or die "creating $fullname.new failed: $!\n";
 165     while (<OLDFILE>) {
 166         if ($. != $line) {
 167             print NEWFILE $_;
 168         } else {
 169             print NEWFILE "AC_INIT([$package], [$version]";
 170             print NEWFILE ", [$_]" foreach @rest;
 171             print NEWFILE ")\n";
 172         }
 173     }
 174     close (NEWFILE);
 175     close (OLDFILE);
 176     rename ("$fullname.new", $fullname)
 177       or die "rename $fullname.new to $fullname failed: $!\n";
 178
 179     # Add note to beginning of NEWS (otherwise "make dist" fails).
 180     start_step ("Updating NEWS");
 181     $fullname = "$builddir/pspp$build_number/NEWS";
 182     open (OLDFILE, '<', $fullname)
 183       or die "opening $fullname failed: $!\n";
 184     open (NEWFILE, '>', "$fullname.new")
 185       or die "creating $fullname.new failed: $!\n";
 186     my $found_changes = 0;
 187     while (<OLDFILE>) {
 188         if (!$found_changes && /^Changes/) {
 189             $found_changes = 1;
 190             print NEWFILE <<EOF;
 191 Changes from $repo_version to $version:
 192
 193  * Built automatically from commit $revision
 194    in branch $branch by builder $builder
 195
 196 EOF
 197         }
 198         print NEWFILE $_;
 199     }
 200     close (NEWFILE);
 201     close (OLDFILE);
 202     rename ("$fullname.new", $fullname)
 203       or die "rename $fullname.new to $fullname failed: $!\n";
 204
 205     # Get Gnulib commit number.
 206     start_step ("Reading README.Git to find Gnulib commit number");
 207     my $gnulib_commit;
 208     $fullname = "$builddir/pspp$build_number/README.Git";
 209     open (README_GIT, '<', $fullname)
 210       or die "opening $fullname failed: $!\n";
 211     while (<README_GIT>) {
 212         ($gnulib_commit) = /^\s+commit ([0-9a-fA-F]{8,})/ and last;
 213     }
 214     die "$fullname does not specify a Git commit number\n"
 215       if !defined ($gnulib_commit);
 216     set_var ("gnulib_commit", $gnulib_commit);
 217
 218     # If we don't already have that Gnulib commit, update Gnulib.
 219     `git rev-parse $gnulib_commit`;
 220     if ($? != 0) {
 221         start_step ("Updating Gnulib to obtain commit");
 222         run ("git fetch gnulib");
 223     }
 224
 225     # Extract gnulib source.
 226     start_step ("Extract Gnulib source");
 227     run ("git archive --format=tar --prefix=gnulib/ $gnulib_commit | (cd $builddir && tar xf -)");
 228
 229     # Bootstrap.
 230     start_step ("Bootstrap (make -f Smake)");
 231     run ("cd $builddir/pspp$build_number && make -f Smake", "bootstrap");
 232
 233     # Configure.
 234     start_step ("Configure source");
 235     run ("cd $builddir/pspp$build_number && mkdir _build && cd _build && ../configure", "configure");
 236
 237     # Distribute.
 238     start_step ("Make source tarball");
 239     run ("cd $builddir/pspp$build_number/_build && make dist", "dist");
 240     my $tarname = "pspp-$version.tar.gz";
 241     $tarball = save_result ("source distribution", "$builddir/pspp$build_number/_build/$tarname", 1);
 242
 243     # Build user manual
 244     start_step ("Build user manual");
 245     run ("cd $builddir/pspp$build_number && cp _build/doc/*.texi doc/");
 246     run ("cd $builddir/pspp$build_number && GENDOCS_TEMPLATE_DIR=$topdir $topdir/gendocs.sh -s doc/pspp.texinfo -o $abs_resultsdir/user-manual --email bug-gnu-pspp\@gnu.org pspp \"GNU PSPP User Manual\"", "user-manual");
 247     saved_result ("User Manual", "user-manual");
 248
 249     # Build developer's guide
 250     start_step ("Build developers guide");
 251     run ("cd $builddir/pspp$build_number && GENDOCS_TEMPLATE_DIR=$topdir $topdir/gendocs.sh -s doc/pspp-dev.texinfo -o $abs_resultsdir/dev-guide --email bug-gnu-pspp\@gnu.org pspp-dev \"GNU PSPP Developers Guide\"", "dev-guide");
 252     saved_result ("Developers Guide", "dev-guide");
 253 } else {
 254     $tarball = $ARGV[0];
 255 }
 256
 257 if ($build_binary) {
 258     start_step ("Determining $tarball target directory");
 259     my $sample_filename = `zcat $tarball | tar tf - | head -1`;
 260     my ($tarball_dir) = $sample_filename =~ m%^(?:[./])*([^/]+)/%;
 261     set_var ("dist_dir", $tarball_dir);
 262
 263     start_step ("Extracting $tarball into $builddir/$tarball_dir");
 264     run ("zcat $tarball | (cd $builddir && tar xf -)");
 265
 266     start_step ("Extracting tar version");
 267     my ($version) = `cd $builddir/$tarball_dir && ./configure --version | head -1`
 268       =~ /configure (\S+)$/;
 269     set_var ("dist_version", $version);
 270     my ($binary_version) = "$version-$builder-build$build_number";
 271     set_var ("binary_version", $binary_version);
 272
 273     start_step ("Configuring");
 274     run ("chmod -R a-w $builddir/$tarball_dir");
 275     run ("chmod u+w $builddir/$tarball_dir");
 276     run ("mkdir $builddir/$tarball_dir/_build");
 277     run ("chmod a-w $builddir/$tarball_dir");
 278     my $ok = try_run ("cd $builddir/$tarball_dir/_build && ../configure --enable-relocatable --prefix=''", "bin-configure");
 279     for my $basename ("config.h", "config.log") {
 280         save_result_if_exists ("build configuration",
 281                                "$builddir/$tarball_dir/_build/$basename");
 282     }
 283     fail () if !$ok;
 284
 285     start_step ("Build");
 286     run ("cd $builddir/$tarball_dir/_build && make", "build");
 287
 288     start_step ("Install");
 289     run ("cd $builddir/$tarball_dir/_build && make install DESTDIR=\$PWD/pspp-$binary_version", "install");
 290
 291     start_step ("Make binary distribution");
 292     run ("cd $builddir/$tarball_dir/_build && tar cfz pspp-$binary_version.tar.gz pspp-$binary_version");
 293     save_result ("binary distribution", "$builddir/$tarball_dir/_build/pspp-$binary_version.tar.gz", 1);
 294
 295     start_step ("Check");
 296     $ok = try_run ("cd $builddir/$tarball_dir/_build && make check", "check");
 297     for my $basename ("tests/testsuite.log", "tests/testsuite.dir") {
 298         save_result_if_exists ("test logs", "$builddir/$tarball_dir/_build/$basename");
 299     }
 300     fail () if !$ok;
 301
 302     start_step ("Uninstall");
 303     run ("cd $builddir/$tarball_dir/_build && make uninstall DESTDIR=\$PWD/pspp-$binary_version", "uninstall");
 304
 305     start_step ("Check uninstall");
 306     run ("cd $builddir/$tarball_dir/_build && make distuninstallcheck distuninstallcheck_dir=\$PWD/pspp-$binary_version", "distuninstallcheck");
 307
 308     # distcleancheck
 309 }
 310
 311 start_step ("Success");
 312
 313 sub usage {
 314     print <<EOF;
 315 $0, for building and testing PSPP
 316 usage: $0 [OPTIONS] [TARBALL | REPO REFSPEC]
 317 where TARBALL is the name of a tarball produced by "make dist"
 318    or REPO and REFSPEC are a Git repo and refspec (e.g. branch) to clone.
 319
 320 Options:
 321   --help            Print this usage message and exit
 322   --no-binary       Build source tarballs but no binaries.
 323   --batch           Do not print progress to stdout.
 324 EOF
 325     exit(0);
 326 }
 327
 328 sub run {
 329     fail () if !try_run (@_);
 330 }
 331
 332 sub try_run {
 333     my ($command, $id) = @_;
 334
 335     print LOG "$command\n";
 336
 337     my $pid = open (COMMAND, '-|');
 338     if (!defined ($pid)) {
 339         die "fork failed: $!\n";
 340     } elsif (!$pid) {
 341         dup2 (1, 2);
 342         exec ($command);
 343         die "$command: exec failed: $!\n";
 344     }
 345
 346     my ($start) = time ();
 347     my ($est_time) = (defined ($id) ? read_timing ($id) : 0);
 348
 349     local ($|) = 1;
 350     my $lines = 0;
 351     while (<COMMAND>) {
 352         print LOG $_;
 353
 354         my $elapsed = time () - $start;
 355         my $progress = sprintf "%d lines logged, %d s elapsed",
 356           $lines++, $elapsed;
 357         if ($est_time > 0) {
 358             my $left = $est_time - $elapsed;
 359             if ($left > 0) {
 360                 $progress .= sprintf ", ETA %d s", $left;
 361             }
 362         }
 363         print "\r$progress", " " x (79 - length ($progress)), "\r"
 364           unless $batch;
 365     }
 366     close (COMMAND);
 367     print "\r", " " x 79, "\r" unless $batch;
 368
 369     write_timing ($id, time () - $start) if defined ($id);
 370
 371     return 1 if !$?;
 372
 373     if ($? & 127) {
 374         printf STDERR "%s: child died with signal %d, %s coredump\n",
 375           $command, ($? & 127),  ($? & 128) ? 'with' : 'without';
 376     } else {
 377         printf STDERR "%s: child exited with value %d\n", $command, $? >> 8;
 378     }
 379     return 0;
 380 }
 381
 382 sub read_timing {
 383     my ($id) = @_;
 384     open (TIMINGS, "<", "$topdir/timings") or return 0;
 385     while (<TIMINGS>) {
 386         chomp;
 387         my ($key, $value) = /^([^=]+)=(.*)/ or next;
 388         return $value if $key eq $id;
 389     }
 390     close (TIMINGS);
 391     return 0;
 392 }
 393
 394 sub write_timing {
 395     my ($id, $time) = @_;
 396
 397     open (NEWTIMINGS, ">", "$topdir/timings.tmp$$") or return;
 398
 399     if (open (OLDTIMINGS, "<", "$topdir/timings")) {
 400         while (<OLDTIMINGS>) {
 401             if (my ($key, $value) = /^([^=]+)=(.*)/) {
 402                 next if $key eq $id;
 403             }
 404             print NEWTIMINGS $_;
 405         }
 406         close (OLDTIMINGS);
 407     }
 408
 409     print NEWTIMINGS "$id=$time\n";
 410     close (NEWTIMINGS);
 411
 412     rename ("$topdir/timings.tmp$$", "$topdir/timings");
 413 }
 414
 415 sub fail {
 416     die "Build failed, refer to:\n\t$topdir/$logfile\nfor details.\n";
 417 }