Improve build
[pspp] / build-pspp
index a20152e2840ebe0b2324070b915a37f3693f0e90..5aeacde8afb819410a6825c52964416f729afeb6 100755 (executable)
@@ -2,12 +2,15 @@
 
 use Getopt::Long qw(:config bundling no_ignore_case);
 use POSIX;
+use Cwd;
 
 use strict;
 use warnings;
 
 my $help = 0;
-GetOptions ("h|help" => \$help);
+my $build_binary = 1;
+GetOptions ("h|help" => \$help,
+           "binary!" => \$build_binary);
 
 usage () if $help;
 
@@ -18,55 +21,116 @@ my $builder = `hostname`;
 chomp $builder;
 
 # Select build number.
-my $buildnumber = POSIX::strftime("%Y%m%d%H%M%S", localtime);
-print "\tBUILDNUMBER=$buildnumber\n";
+my $build_number = POSIX::strftime("%Y%m%d%H%M%S", localtime);
+
+my $topdir = getcwd ();
 
 # Create build directory.
-my $builddir = "builds/$buildnumber";
-print "Create $builddir\n";
+my $builddir = "builds/$build_number";
 mkdir "builds" or die "builds: mkdir: $!\n" if ! -d "builds";
 mkdir $builddir or die "$builddir: mkdir: $!\n";
 
-$resultsdir = "$builddir/results";
+our $resultsdir = "$builddir/results";
 mkdir $resultsdir or die "$resultsdir: mkdir: $!\n";
+mkdir "$resultsdir/vars" or die "$resultsdir/vars: mkdir: $!\n";
 
-$logfile = "$resultsdir/LOG";
+my $logfile = "$resultsdir/LOG";
 open (LOG, '>', $logfile) or die "creating $logfile failed: $!\n";
 
-$varsfile = "$resultsdir/VARS";
-open (VARS, '>', $varsfile) or die "creating $varsfile failed: $!\n";
+set_var ("builder", $builder);
+set_var ("build_number", $build_number);
+
+sub start_step {
+    my ($msg) = @_;
+    print LOG "\f\n$msg\n";
+    print "$msg\n";
+}
+
+sub set_var {
+    my ($var, $value) = @_;
+    open (VAR, '>', "$resultsdir/vars/$var")
+      or die "creating $resultsdir/$var failed: $!\n";
+    print VAR "$value\n";
+    close VAR;
+    print LOG "$var=$value\n";
+    print "\t$var=$value\n";
+}
+
+sub save_result {
+    my ($src, $rm_src) = @_;
+    my ($dst) = $src;
+    $dst =~ s(^.*/)();
+    $dst = "$resultsdir/$dst";
 
+    start_step ("Saving $src");
+    run ("cp -R $src $dst");
 
+    if (defined ($rm_src) && $rm_src) {
+       run ("rm $src");
+    }
 
+    return $dst;
+}
 
+sub save_result_if_exists {
+    my ($src, $rm_src) = @_;
+    if (-e $src) {
+       save_result (@_);
+    } else {
+       start_step ("$src does not exist, cannot save");
+    }
+}
 
 my $tarball;
 if (@ARGV == 2) {
     my ($repo, $branch) = @ARGV;
 
     # Fetch branch
-    print "Fetch $repo, branch $branch\n";
+    start_step ("Fetch $repo, branch $branch");
     run ("git fetch $repo +$branch:buildtmp/$$/pspp");
 
     # Get revision number.
     my $revision = `git rev-parse buildtmp/$$/pspp`;
     chomp $revision;
-    print "\tREVISION=$revision\n";
-    my $abbrev_revision = substr ($revision, 0, 6);
+    set_var ("pspp_commit", $revision);
+    my $abbrev_commit = substr ($revision, 0, 6);
 
     # Extract source.
-    print "Extract branch into $builddir/pspp$buildnumber\n";
-    run ("git archive --format=tar --prefix=pspp$buildnumber/ buildtmp/$$/pspp | (cd $builddir && tar xf -)");
+    start_step ("Extract branch into $builddir/pspp$build_number");
+    run ("git archive --format=tar --prefix=pspp$build_number/ buildtmp/$$/pspp | (cd $builddir && tar xf -)");
 
     # Extract version number.
-    print "Extract version number\n";
-    my $trace = `cd $builddir/pspp$buildnumber && autoconf -t AC_INIT`;
+    start_step ("Extract repository version number");
+    my $trace = `cd $builddir/pspp$build_number && autoconf -t AC_INIT`;
     chomp $trace;
-    my ($file, $line, $macro, $package, $version, @rest) = split (':', $trace);
-    print "\tVERSION=$version\n";
-
-    # Append -g012345 to AC_INIT version number.
-    my $fullname = "$builddir/pspp$buildnumber/$file";
+    my ($file, $line, $macro, $package, $repo_version, @rest)
+      = split (':', $trace);
+    set_var ("repo_version", $repo_version);
+
+    # Is this a "gnits" mode tree?
+    start_step ("Checking Automake mode");
+    open (MAKEFILE_AM, '<', "$builddir/pspp$build_number/Makefile.am");
+    my $am_mode = "gnu";
+    while (<MAKEFILE>) {
+       if (/gnits/) {
+           $am_mode = "gnits";
+           last;
+       }
+    }
+    set_var ("am_mode", $am_mode);
+
+    # Generate version number for build.
+    # We want to append -g012345, but if we're in Gnits mode and the
+    # version number already has a hyphen, we have to omit it.
+    start_step ("Generate build version number");
+    my $version = $repo_version;
+    $version .= '-' unless $version =~ /-/;
+    $version .= "g$abbrev_commit";
+    set_var ("version", $version);
+
+    # Append -g012345 to configure.ac version number.
+    start_step ("Updating version number in $file");
+    my $fullname = "$builddir/pspp$build_number/$file";
     open (OLDFILE, '<', $fullname)
       or die "opening $fullname failed: $!\n";
     open (NEWFILE, '>', "$fullname.new")
@@ -75,7 +139,7 @@ if (@ARGV == 2) {
        if ($. != $line) {
            print NEWFILE $_;
        } else {
-           print NEWFILE "AC_INIT([$package], [$version-g$abbrev_revision]";
+           print NEWFILE "AC_INIT([$package], [$version]";
            print NEWFILE ", [$_]" foreach @rest;
            print NEWFILE ")\n";
        }
@@ -86,7 +150,8 @@ if (@ARGV == 2) {
       or die "rename $fullname.new to $fullname failed: $!\n";
 
     # Add note to beginning of NEWS (otherwise "make dist" fails).
-    $fullname = "$builddir/pspp$buildnumber/NEWS";
+    start_step ("Updating NEWS");
+    $fullname = "$builddir/pspp$build_number/NEWS";
     open (OLDFILE, '<', $fullname)
       or die "opening $fullname failed: $!\n";
     open (NEWFILE, '>', "$fullname.new")
@@ -96,7 +161,7 @@ if (@ARGV == 2) {
        if (!$found_changes && /^Changes/) {
            $found_changes = 1;
            print NEWFILE <<EOF;
-Changes from $version to $version-g$abbrev_revision:
+Changes from $repo_version to $version:
 
  * Built automatically from commit $revision
    in branch $branch by builder $builder
@@ -111,8 +176,9 @@ EOF
       or die "rename $fullname.new to $fullname failed: $!\n";
 
     # Get Gnulib commit number.
+    start_step ("Reading README.Git to find Gnulib commit number");
     my $gnulib_commit;
-    $fullname = "$builddir/pspp$buildnumber/README.Git";
+    $fullname = "$builddir/pspp$build_number/README.Git";
     open (README_GIT, '<', $fullname)
       or die "opening $fullname failed: $!\n";
     while (<README_GIT>) {
@@ -120,74 +186,99 @@ EOF
     }
     die "$fullname does not specify a Git commit number\n"
       if !defined ($gnulib_commit);
-    print "\tGNULIB_REVISION=$gnulib_commit\n";
+    set_var ("gnulib_commit", $gnulib_commit);
 
     # If we don't already have that Gnulib commit, update Gnulib.
     `git rev-parse $gnulib_commit`;
     if ($? != 0) {
+       start_step ("Updating Gnulib to obtain commit");
        run ("git fetch gnulib");
     }
 
     # Extract gnulib source.
+    start_step ("Extract Gnulib source");
     run ("git archive --format=tar --prefix=gnulib/ $gnulib_commit | (cd $builddir && tar xf -)");
 
     # Bootstrap.
-    run ("cd $builddir/pspp$buildnumber && make -f Smake");
+    start_step ("Bootstrap (make -f Smake)");
+    run ("cd $builddir/pspp$build_number && make -f Smake");
 
     # Configure.
-    run ("cd $builddir/pspp$buildnumber && mkdir _build && cd _build && ../configure");
+    start_step ("Configure source");
+    run ("cd $builddir/pspp$build_number && mkdir _build && cd _build && ../configure");
 
     # Distribute.
-    run ("cd $builddir/pspp$buildnumber/_build && make dist");
-
-    $tarball = "$builddir/pspp$buildnumber/_build/pspp-$version-g$abbrev_revision.tar.gz";
+    start_step ("Make source tarball");
+    run ("cd $builddir/pspp$build_number/_build && make dist");
+    my $tarname = "pspp-$version.tar.gz";
+    $tarball = save_result ("$builddir/pspp$build_number/_build/$tarname", 1);
+
+    # Build user manual
+    start_step ("Build user manual");
+    run ("cd $builddir/pspp$build_number && cp _build/doc/*.texi doc/");
+    run ("cd $builddir/pspp$build_number && GENDOCS_TEMPLATE_DIR=$topdir $topdir/gendocs.sh -s doc/pspp.texinfo -o $topdir/$builddir/results/user-manual --email bug-gnu-pspp\@gnu.org pspp \"GNU PSPP User Manual\"");
+
+    # Build developer's guide
+    start_step ("Build developers guide");
+    run ("cd $builddir/pspp$build_number && GENDOCS_TEMPLATE_DIR=$topdir $topdir/gendocs.sh -s doc/pspp-dev.texinfo -o $topdir/$builddir/results/dev-guide --email bug-gnu-pspp\@gnu.org pspp \"GNU PSPP Developers Guide\"");
 } else {
     $tarball = $ARGV[0];
 }
 
-print "Determining $tarball target directory\n";
-my $sample_filename = `zcat $tarball | tar tf - | head -1`;
-my ($tarball_dir) = $sample_filename =~ m%^(?:[./])*([^/]+)/%;
-print "\tTARBALL_DIR=$tarball_dir\n";
-
-print "Extracting $tarball into $builddir/$tarball_dir\n";
-run ("zcat $tarball | (cd $builddir && tar xf -)");
-
-print "Extracting tar version\n";
-my ($version) = `cd $builddir/$tarball_dir && ./configure --version | head -1`
-  =~ /configure (\S+)$/;
-print "\tVERSION=$version\n";
-my ($binary_version) = "$version-$builder-build$buildnumber";
-print "\tBINARY_VERSION=$version\n";
-
-print "Configuring\n";
-run ("chmod -R a-w $builddir/$tarball_dir");
-run ("chmod u+w $builddir/$tarball_dir");
-run ("mkdir $builddir/$tarball_dir/_build");
-run ("chmod a-w $builddir/$tarball_dir");
-run ("cd $builddir/$tarball_dir/_build && ../configure --enable-relocatable --prefix=''");
+if ($build_binary) {
+    start_step ("Determining $tarball target directory");
+    my $sample_filename = `zcat $tarball | tar tf - | head -1`;
+    my ($tarball_dir) = $sample_filename =~ m%^(?:[./])*([^/]+)/%;
+    set_var ("dist_dir", $tarball_dir);
+
+    start_step ("Extracting $tarball into $builddir/$tarball_dir");
+    run ("zcat $tarball | (cd $builddir && tar xf -)");
+
+    start_step ("Extracting tar version");
+    my ($version) = `cd $builddir/$tarball_dir && ./configure --version | head -1`
+      =~ /configure (\S+)$/;
+    set_var ("dist_version", $version);
+    my ($binary_version) = "$version-$builder-build$build_number";
+    set_var ("binary_version", $binary_version);
+
+    start_step ("Configuring");
+    run ("chmod -R a-w $builddir/$tarball_dir");
+    run ("chmod u+w $builddir/$tarball_dir");
+    run ("mkdir $builddir/$tarball_dir/_build");
+    run ("chmod a-w $builddir/$tarball_dir");
+    my $ok = try_run ("cd $builddir/$tarball_dir/_build && ../configure --enable-relocatable --prefix=''");
+    for my $basename ("config.h", "config.log") {
+       save_result_if_exists ("$builddir/$tarball_dir/_build/$basename");
+    }
+    exit 1 if !$ok;
 
-print "Build\n";
-run ("cd $builddir/$tarball_dir/_build && make");
+    start_step ("Build");
+    run ("cd $builddir/$tarball_dir/_build && make");
 
-print "Install\n";
-run ("cd $builddir/$tarball_dir/_build && make install DESTDIR=\$PWD/pspp-$binary_version");
+    start_step ("Install");
+    run ("cd $builddir/$tarball_dir/_build && make install DESTDIR=\$PWD/pspp-$binary_version");
 
-print "Make binary distribution\n";
-run ("cd $builddir/$tarball_dir/_build && tar cfz pspp-$binary_version.tar.gz pspp-$binary_version");
+    start_step ("Make binary distribution");
+    run ("cd $builddir/$tarball_dir/_build && tar cfz pspp-$binary_version.tar.gz pspp-$binary_version");
+    save_result ("$builddir/$tarball_dir/_build/pspp-$binary_version.tar.gz", 1);
 
-print "Check\n";
-run ("cd $builddir/$tarball_dir/_build && make check");
+    start_step ("Check");
+    $ok = try_run ("cd $builddir/$tarball_dir/_build && make check");
+    for my $basename ("tests/testsuite.log", "tests/testsuite.dir") {
+       save_result_if_exists ("$builddir/$tarball_dir/_build/$basename");
+    }
+    exit 1 if !$ok;
 
-print "Uninstall\n";
-run ("cd $builddir/$tarball_dir/_build && make uninstall DESTDIR=\$PWD/pspp-$binary_version");
+    start_step ("Uninstall");
+    run ("cd $builddir/$tarball_dir/_build && make uninstall DESTDIR=\$PWD/pspp-$binary_version");
 
-print "Check uninstall\n";
-run ("cd $builddir/$tarball_dir/_build && make distuninstallcheck distuninstallcheck_dir=\$PWD/pspp-$binary_version");
+    start_step ("Check uninstall");
+    run ("cd $builddir/$tarball_dir/_build && make distuninstallcheck distuninstallcheck_dir=\$PWD/pspp-$binary_version");
 
-# distcleancheck
+    # distcleancheck
+}
 
-print "Success\n";
+start_step ("Success");
 
 sub usage {
     print <<EOF;
@@ -203,33 +294,39 @@ EOF
 }
 
 sub run {
+    exit 1 if !try_run(@_);
+}
+
+sub try_run {
     my ($command) = @_;
-    return if system ($command) == 0;
-    if ($? == -1) {
-       print "$command: failed to execute: $!\n";
-    } elsif ($? & 127) {
+
+    print LOG "$command\n";
+
+    my $pid = open (COMMAND, '-|');
+    if (!defined ($pid)) {
+       die "fork failed: $!\n";
+    } elsif (!$pid) {
+       dup2 (1, 2);
+       exec ($command);
+       die "$command: exec failed: $!\n";
+    }
+
+    local ($|) = 1;
+    my $i = 0;
+    while (<COMMAND>) {
+       print LOG $_;
+       print "\r", $i++;
+    }
+    close (COMMAND);
+    print "\r      \r";
+
+    return 1 if !$?;
+
+    if ($? & 127) {
        printf "%s: child died with signal %d, %s coredump\n",
          $command, ($? & 127),  ($? & 128) ? 'with' : 'without';
     } else {
        printf "%s: child exited with value %d\n", $command, $? >> 8;
     }
-    exit 1;
+    return 0;
 }
-
-# Clone source
-# Add build number
-# Tag build
-# Clone gnulib at correct commit number
-# Run gnulib-tool.
-# Run configure
-# Make dist
-
-# Unpack dist
-# Run configure
-# Check
-# Install
-# Make binary dist
-# Build mingw32 installer
-# Other distcheck stuff?
-
-# Distribute manual in various formats