run_build.pl

   1 #!/usr/bin/perl
   2
   3 =comment
   4
   5 Copyright (c) 2003-2010, Andrew Dunstan
   6
   7 See accompanying License file for license details
   8
   9 =cut
  10
  11 ####################################################
  12
  13 =comment
  14
  15  NAME: run_build.pl - script to run exim buildfarm
  16
  17  SYNOPSIS:
  18
  19   run_build.pl [option ...] [branchname]
  20
  21  AUTHOR: Andrew Dunstan
  22
  23  DOCUMENTATION:
  24
  25   See http://wiki.exim.org/wiki/PostgreSQL_Buildfarm_Howto
  26
  27  REPOSITORY:
  28
  29   https://github.com/EximBuildFarm/client-code
  30
  31 =cut
  32
  33 ###################################################
  34
  35 use vars qw($VERSION); $VERSION = 'REL_0.1';
  36
  37 use strict;
  38 use warnings;
  39 use Config;
  40 use Fcntl qw(:flock :seek);
  41 use File::Path;
  42 use File::Copy;
  43 use File::Basename;
  44 use File::Temp;
  45 use File::Spec;
  46 use IO::Handle;
  47 use POSIX qw(:signal_h strftime);
  48 use Data::Dumper;
  49 use Cwd qw(abs_path getcwd);
  50 use File::Find ();
  51
  52 # save a copy of the original enviroment for reporting
  53 # save it early to reduce the risk of prior mangling
  54 use vars qw($orig_env);
  55
  56 BEGIN
  57 {
  58     $orig_env = {};
  59     while (my ($k,$v) = each %ENV)
  60     {
  61
  62         # report all the keys but only values for whitelisted settings
  63         # this is to stop leaking of things like passwords
  64         $orig_env->{$k} =(
  65             (
  66                     $k =~ /^PG(?!PASSWORD)|MAKE|CC|CPP|FLAG|LIBRAR|INCLUDE/
  67                   ||$k =~/^(HOME|LOGNAME|USER|PATH|SHELL)$/
  68             )
  69             ? $v
  70             : 'xxxxxx'
  71         );
  72     }
  73 }
  74
  75 use EximBuild::SCM;
  76 use EximBuild::Options;
  77 use EximBuild::WebTxn;
  78
  79 my %module_hooks;
  80 my $orig_dir = getcwd();
  81 push @INC, $orig_dir;
  82
  83 # make sure we exit nicely on any normal interrupt
  84 # so the cleanup handler gets called.
  85 # that lets us stop the db if it's running and
  86 # remove the inst and exim directories
  87 # so the next run can start clean.
  88
  89 foreach my $sig (qw(INT TERM HUP QUIT))
  90 {
  91     $SIG{$sig}=\&interrupt_exit;
  92 }
  93
  94 # copy command line before processing - so we can later report it
  95 # unmunged
  96
  97 my @invocation_args = (@ARGV);
  98
  99 # process the command line
 100 EximBuild::Options::fetch_options();
 101
 102 die "only one of --from-source and --from-source-clean allowed"
 103   if ($from_source && $from_source_clean);
 104
 105 die "only one of --skip-steps and --only-steps allowed"
 106   if ($skip_steps && $only_steps);
 107
 108 $verbose=1 if (defined($verbose) && $verbose==0);
 109 $verbose ||= 0; # stop complaints about undefined var in numeric comparison
 110
 111 if ($testmode)
 112 {
 113     $verbose=1 unless $verbose;
 114     $forcerun = 1;
 115     $nostatus = 1;
 116     $nosend = 1;
 117
 118 }
 119
 120 use vars qw(%skip_steps %only_steps);
 121 $skip_steps ||= "";
 122 if ($skip_steps =~ /\S/)
 123 {
 124     %skip_steps = map {$_ => 1} split(/\s+/,$skip_steps);
 125 }
 126 $only_steps ||= "";
 127 if ($only_steps =~ /\S/)
 128 {
 129     %only_steps = map {$_ => 1} split(/(\s+|[:,])/,$only_steps);
 130 }
 131
 132 # Currently only specifying a branch is actually used.
 133 # Specifying a different repo is just a wishlist item .
 134 use vars qw($branch $repo);
 135 my ($arg1,$arg2) = (shift,shift);
 136 $branch = $arg2 ? $arg2 :
 137           $arg1 ? $arg1 :
 138           'HEAD';
 139 $repo = $arg2 ? $arg1 : 'exim';
 140 my $explicit_branch = $branch;
 141
 142 print_help() if ($help);
 143
 144 #
 145 # process config file
 146 #
 147 require $buildconf;
 148
 149 # get the config data into some local variables
 150 my (
 151     $buildroot,$target,$animal, $print_success,
 152     $aux_path,$trigger_exclude,$trigger_include,$secret,
 153     $keep_errs,$force_every, $make, $optional_steps,
 154     $use_vpath,$tar_log_cmd, $using_msvc, $extra_config,
 155     $make_jobs, $core_file_glob
 156   )
 157   =@EximBuild::conf{
 158     qw(build_root target animal print_success aux_path trigger_exclude
 159       trigger_include secret keep_error_builds force_every make optional_steps
 160       use_vpath tar_log_cmd using_msvc extra_config make_jobs core_file_glob)
 161   };
 162
 163 #default is no parallel build
 164 $make_jobs ||= 1;
 165
 166 # default core file pattern is Linux, which used to be hardcoded
 167 $core_file_glob ||= 'core*';
 168
 169 # legacy name
 170 if (defined($EximBuild::conf{trigger_filter}))
 171 {
 172     $trigger_exclude = $EximBuild::conf{trigger_filter};
 173 }
 174
 175 my  $scm_timeout_secs = $EximBuild::conf{scm_timeout_secs}
 176   || $EximBuild::conf{cvs_timeout_secs};
 177
 178 print scalar(localtime()),": buildfarm run for $animal:$branch starting\n"
 179   if $verbose;
 180
 181 # Allow commandline overrides of conf variables
 182 foreach my $arg ( @{$EximBuild::Options::overrides} )
 183 {
 184   if (my ($key,$val) = split '=', $arg)
 185   {
 186     $EximBuild::conf{$key} = $val;
 187     printf "Commandline override: '$key' = '%s'\n", $EximBuild::conf{$key}
 188       if $verbose;
 189   }
 190 }
 191
 192 if (ref($force_every) eq 'HASH')
 193 {
 194     $force_every = $force_every->{$branch} || $force_every->{default};
 195 }
 196
 197 my $scm = new EximBuild::SCM \%EximBuild::conf;
 198
 199 my $buildport;
 200
 201 if (exists $EximBuild::conf{base_port})
 202 {
 203     $buildport = $EximBuild::conf{base_port};
 204     if ($branch =~ /REL(\d+)_(\d+)/)
 205     {
 206         $buildport += (10 * ($1 - 7)) + $2;
 207     }
 208 }
 209 else
 210 {
 211
 212     # support for legacy config style
 213     $buildport = $EximBuild::conf{branch_ports}->{$branch} || 5999;
 214 }
 215
 216 $ENV{EXTRA_REGRESS_OPTS} = "--port=$buildport";
 217
 218 $tar_log_cmd ||= "tar -z -cf runlogs.tgz *.log";
 219
 220 my $logdirname = "lastrun-logs";
 221
 222 if ($from_source || $from_source_clean)
 223 {
 224     $from_source ||= $from_source_clean;
 225     die "sourceroot $from_source not absolute"
 226       unless $from_source =~ m!^/!;
 227
 228     # we need to know where the lock should go, so unless the path
 229     # contains HEAD we require it to be specified.
 230     die "must specify branch explicitly with from_source"
 231       unless ($explicit_branch || $from_source =~ m!/HEAD/!);
 232     $verbose ||= 1;
 233     $nosend=1;
 234     $nostatus=1;
 235     $use_vpath = undef;
 236     $logdirname = "fromsource-logs";
 237 }
 238
 239 my @locales;
 240 if ($branch eq 'HEAD' || $branch ge 'REL8_4')
 241 {
 242
 243     # non-C locales are not regression-safe before 8.4
 244     @locales = @{$EximBuild::conf{locales}} if exists $EximBuild::conf{locales};
 245 }
 246 unshift(@locales,'C') unless grep {$_ eq "C"} @locales;
 247
 248 # sanity checks
 249 # several people have run into these
 250
 251 if ( `uname -s 2>&1 ` =~ /CYGWIN/i )
 252 {
 253     my @procs = `ps -ef`;
 254     die "cygserver not running" unless(grep {/cygserver/} @procs);
 255 }
 256 my $ccachedir;
 257 if ( $ccachedir = $EximBuild::conf{build_env}->{CCACHE_DIR} )
 258 {
 259
 260     # ccache is smart enough to create what you tell it is the cache dir, but
 261     # not smart enough to build the whole path. mkpath croaks on error, so
 262     # we just let it.
 263
 264     mkpath $ccachedir;
 265     $ccachedir = abs_path($ccachedir);
 266 }
 267
 268 if ($^V lt v5.8.0)
 269 {
 270     die "no aux_path in config file" unless $aux_path;
 271 }
 272
 273 die "cannot run as root/Administrator" unless ($using_msvc or $> > 0);
 274
 275 my $devnull = $using_msvc ? "nul" : "/dev/null";
 276
 277 if (!$from_source)
 278 {
 279     $scm->check_access($using_msvc);
 280 }
 281
 282 my $st_prefix = "$animal.";
 283
 284 my $exim = $from_source  || $scm->get_build_path($use_vpath);
 285
 286 # set environment from config
 287 while (my ($envkey,$envval) = each %{$EximBuild::conf{build_env}})
 288 {
 289     $ENV{$envkey}=$envval;
 290 }
 291
 292 # change to buildroot for this branch or die
 293 die "no buildroot" unless $buildroot;
 294
 295 unless ($buildroot =~ m!^/!
 296     or($using_msvc and $buildroot =~ m![a-z]:[/\\]!i ))
 297 {
 298     die "buildroot $buildroot not absolute";
 299 }
 300
 301 die "$buildroot does not exist or is not a directory" unless -d $buildroot;
 302
 303 chdir $buildroot || die "chdir to $buildroot: $!";
 304
 305 mkdir $branch unless -d $branch;
 306 chdir $branch || die "chdir to $buildroot/$branch";
 307
 308 # rename legacy status files/directories
 309 foreach my $oldfile (glob("last*"))
 310 {
 311     move $oldfile, "$st_prefix$oldfile";
 312 }
 313
 314 my $branch_root = getcwd();
 315
 316 # make sure we are using GNU make
 317 die "$make is not GNU Make - please fix config file"
 318   unless check_make();
 319
 320 # set up modules
 321 foreach my $module (@{$EximBuild::conf{modules}})
 322 {
 323
 324     # fill in the name of the module here, so use double quotes
 325     # so everything BUT the module name needs to be escaped
 326     my $str = qq!
 327          require EximBuild::Modules::$module;
 328          EximBuild::Modules::${module}::setup(
 329               \$buildroot,
 330               \$branch,
 331               \\\%EximBuild::conf,
 332               \$exim);
 333     !;
 334     eval $str;
 335
 336     # make errors fatal
 337     die $@ if $@;
 338 }
 339
 340 # acquire the lock
 341
 342 my $lockfile;
 343 my $have_lock;
 344
 345 open($lockfile, ">builder.LCK") || die "opening lockfile: $!";
 346
 347 # only one builder at a time allowed per branch
 348 # having another build running is not a failure, and so we do not output
 349 # a failure message under this condition.
 350 if ($from_source)
 351 {
 352     die "acquiring lock in $buildroot/$branch/builder.LCK"
 353       unless flock($lockfile,LOCK_EX|LOCK_NB);
 354 }
 355 elsif ( !flock($lockfile,LOCK_EX|LOCK_NB) )
 356 {
 357     print "Another process holds the lock on "
 358       ."$buildroot/$branch/builder.LCK. Exiting."
 359       if ($verbose);
 360     exit(0);
 361 }
 362
 363 die "$buildroot/$branch has $exim or inst directories!"
 364   if ((!$from_source && -d $exim) || -d "inst");
 365
 366 # we are OK to run if we get here
 367 $have_lock = 1;
 368
 369 # check if file present for forced run
 370 my $forcefile = $st_prefix . "force-one-run";
 371 if (-e $forcefile)
 372 {
 373     $forcerun = 1;
 374     unlink $forcefile;
 375 }
 376
 377 # try to allow core files to be produced.
 378 # another way would be for the calling environment
 379 # to call ulimit. We do this in an eval so failure is
 380 # not fatal.
 381 eval{
 382     require BSD::Resource;
 383     BSD::Resource->import();
 384
 385     # explicit sub calls here. using & keeps compiler happy
 386     my $coreok = setrlimit(&RLIMIT_CORE,&RLIM_INFINITY,&RLIM_INFINITY);
 387     die "setrlimit" unless $coreok;
 388 };
 389 warn "failed to unlimit core size: $@" if $@ && $verbose > 1;
 390
 391 # the time we take the snapshot
 392 my $now=time;
 393 my $installdir = "$buildroot/$branch/inst";
 394 my $dbstarted;
 395
 396 my $extraconf;
 397
 398 # cleanup handler for all exits
 399 END
 400 {
 401
 402     # clean up temp file
 403     unlink $ENV{TEMP_CONFIG} if $extraconf;
 404
 405     # if we have the lock we must already be in the build root, so
 406     # removing things there should be safe.
 407     # there should only be anything to cleanup if we didn't have
 408     # success.
 409     if ( $have_lock && -d "$exim")
 410     {
 411         if ($dbstarted)
 412         {
 413             chdir $installdir;
 414             system(qq{"bin/pg_ctl" -D data stop >$devnull 2>&1});
 415             foreach my $loc (@locales)
 416             {
 417                 next unless -d "data-$loc";
 418                 system(qq{"bin/pg_ctl" -D "data-$loc" stop >$devnull 2>&1});
 419             }
 420             chdir $branch_root;
 421         }
 422         if ( !$from_source && $keep_errs)
 423         {
 424             print "moving kept error trees\n" if $verbose;
 425             my $timestr = strftime "%Y-%m-%d_%H-%M-%S", localtime($now);
 426             unless (move("$exim", "eximkeep.$timestr"))
 427             {
 428                 print "error renaming '$exim' to 'eximkeep.$timestr': $!";
 429             }
 430             if (-d "inst")
 431             {
 432                 unless(move("inst", "instkeep.$timestr"))
 433                 {
 434                     print "error renaming 'inst' to 'instkeep.$timestr': $!";
 435                 }
 436             }
 437         }
 438         else
 439         {
 440             rmtree("inst") unless $keepall;
 441             rmtree("$exim") unless ($from_source || $keepall);
 442         }
 443
 444         # only keep the cache in cases of success
 445         rmtree("$ccachedir") if $ccachedir;
 446     }
 447
 448     # get the modules to clean up after themselves
 449     process_module_hooks('cleanup');
 450
 451     if ($have_lock)
 452     {
 453         if ($use_vpath)
 454         {
 455
 456             # vpath builds leave some stuff lying around in the
 457             # source dir, unfortunately. This should clean it up.
 458             $scm->cleanup();
 459         }
 460         close($lockfile);
 461         unlink("builder.LCK");
 462     }
 463 }
 464
 465 # Prepend the DEFAULT settings (if any) to any settings for the
 466 # branch. Since we're mangling this, deep clone $extra_config
 467 # so the config object is kept as given. This is done using
 468 # Dumper() because the MSys DTK perl doesn't have Storable. This
 469 # is less efficient but it hardly matters here for this shallow
 470 # structure.
 471
 472 $extra_config = eval Dumper($extra_config);
 473
 474 if ($extra_config &&  $extra_config->{DEFAULT})
 475 {
 476     if (!exists  $extra_config->{$branch})
 477     {
 478         $extra_config->{$branch} =      $extra_config->{DEFAULT};
 479     }
 480     else
 481     {
 482         unshift(@{$extra_config->{$branch}}, @{$extra_config->{DEFAULT}});
 483     }
 484 }
 485
 486 if ($extra_config && $extra_config->{$branch})
 487 {
 488     my $tmpname;
 489     ($extraconf,$tmpname) =File::Temp::tempfile(
 490         'buildfarm-XXXXXX',
 491         DIR => File::Spec->tmpdir(),
 492         UNLINK => 1
 493     );
 494     die 'no $tmpname!' unless $tmpname;
 495     $ENV{TEMP_CONFIG} = $tmpname;
 496     foreach my $line (@{$extra_config->{$branch}})
 497     {
 498         print $extraconf "$line\n";
 499     }
 500     autoflush $extraconf 1;
 501 }
 502
 503 use vars qw($steps_completed);
 504 $steps_completed = "";
 505
 506 my @changed_files;
 507 my @changed_since_success;
 508 my $last_status;
 509 my $last_run_snap;
 510 my $last_success_snap;
 511 my $current_snap;
 512 my @filtered_files;
 513 my $savescmlog = "";
 514
 515 if ($from_source_clean)
 516 {
 517     print time_str(),"cleaning source in $exim ...\n";
 518     clean_from_source();
 519 }
 520 elsif (!$from_source)
 521 {
 522
 523     # see if we need to run the tests (i.e. if either something has changed or
 524     # we have gone over the force_every heartbeat time)
 525
 526     print time_str(),"checking out source ...\n" if $verbose;
 527
 528     my $timeout_pid;
 529
 530     $timeout_pid = spawn(\&scm_timeout,$scm_timeout_secs)
 531       if $scm_timeout_secs;
 532
 533     $savescmlog = $scm->checkout($branch);
 534     $steps_completed = "SCM-checkout";
 535
 536     process_module_hooks('checkout',$savescmlog);
 537
 538     if ($timeout_pid)
 539     {
 540
 541         # don't kill me, I finished in time
 542         if (kill(SIGTERM, $timeout_pid))
 543         {
 544
 545             # reap the zombie
 546             waitpid($timeout_pid,0);
 547         }
 548     }
 549
 550     print time_str(),"checking if build run needed ...\n" if $verbose;
 551
 552     # transition to new time processing
 553     unlink "last.success";
 554
 555     # get the timestamp data
 556     $last_status = find_last('status') || 0;
 557     $last_run_snap = find_last('run.snap');
 558     $last_success_snap = find_last('success.snap');
 559     $forcerun = 1 unless (defined($last_run_snap));
 560
 561     # updated by find_changed to last mtime of any file in the repo
 562     $current_snap=0;
 563
 564     # see if we need to force a build
 565     $last_status = 0
 566       if ( $last_status
 567         && $force_every
 568         &&$last_status+($force_every*3600) < $now);
 569     $last_status = 0 if $forcerun;
 570
 571     # see what's changed since the last time we did work
 572     $scm->find_changed(\$current_snap,$last_run_snap, $last_success_snap,
 573         \@changed_files,\@changed_since_success);
 574
 575     #ignore changes to files specified by the trigger exclude filter, if any
 576     if (defined($trigger_exclude))
 577     {
 578         @filtered_files = grep { !m[$trigger_exclude] } @changed_files;
 579     }
 580     else
 581     {
 582         @filtered_files = @changed_files;
 583     }
 584
 585     #ignore changes to files NOT specified by the trigger include filter, if any
 586     if (defined($trigger_include))
 587     {
 588         @filtered_files = grep { m[$trigger_include] } @filtered_files;
 589     }
 590
 591     my $modules_need_run;
 592
 593     process_module_hooks('need-run',\$modules_need_run);
 594
 595     # if no build required do nothing
 596     if ($last_status && !@filtered_files && !$modules_need_run)
 597     {
 598         print time_str(),
 599           "No build required: last status = ",scalar(gmtime($last_status)),
 600           " GMT, current snapshot = ",scalar(gmtime($current_snap))," GMT,",
 601           " changed files = ",scalar(@filtered_files),"\n"
 602           if $verbose;
 603         rmtree("$exim");
 604         exit 0;
 605     }
 606
 607     # get version info on both changed files sets
 608     # XXX modules support?
 609
 610     $scm->get_versions(\@changed_files);
 611     $scm->get_versions(\@changed_since_success);
 612
 613 } # end of unless ($from_source)
 614
 615 cleanlogs();
 616
 617 writelog('SCM-checkout',$savescmlog) unless $from_source;
 618 $scm->log_id() unless $from_source;
 619
 620 # copy/create according to vpath/scm settings
 621
 622 if ($use_vpath)
 623 {
 624     print time_str(),"creating vpath build dir $exim ...\n" if $verbose;
 625     mkdir $exim || die "making $exim: $!";
 626 }
 627 elsif (!$from_source && $scm->copy_source_required())
 628 {
 629     print time_str(),"copying source to $exim ...\n" if $verbose;
 630
 631     $scm->copy_source($using_msvc);
 632 }
 633
 634 process_module_hooks('setup-target');
 635
 636 # start working
 637
 638 set_last('status',$now) unless $nostatus;
 639 set_last('run.snap',$current_snap) unless $nostatus;
 640
 641 my $started_times = 0;
 642 print time_str(),"running configure ...\n" if $verbose;
 643
 644 # each of these routines will call send_result, which calls exit,
 645 # on any error, so each step depends on success in the previous
 646 # steps.
 647 configure();
 648
 649 make();
 650
 651 display_features();
 652
 653 make_test() if (check_optional_step('make_test'));
 654
 655 make_doc() if (check_optional_step('build_docs'));
 656
 657 ##check_port_is_ok($buildport,'Post');
 658
 659 # if we get here everything went fine ...
 660
 661 my $saved_config = get_config_summary();
 662
 663 rmtree("inst"); # only keep failures
 664 rmtree("$exim") unless ($from_source || $keepall);
 665
 666 print(time_str(),"OK\n") if $verbose;
 667
 668 send_result("OK");
 669
 670 exit;
 671
 672 ############## end of main program ###########################
 673
 674 sub print_help
 675 {
 676     print qq!
 677 usage: $0 [options] [branch]
 678
 679  where options are one or more of:
 680
 681   --nosend                  = don't send results
 682   --nostatus                = don't set status files
 683   --force                   = force a build run (ignore status files)
 684   --from-source=/path       = use source in path, not from SCM
 685   or
 686   --from-source-clean=/path = same as --from-source, run make distclean first
 687   --config=/path/to/file    = alternative location for config file
 688   --keepall                 = keep directories if an error occurs
 689   --verbose[=n]             = verbosity (default 1) 2 or more = huge output.
 690   --quiet                   = suppress normal error message
 691   --test                    = short for --nosend --nostatus --verbose --force
 692   --skip-steps=list         = skip certain steps
 693   --only-steps=list         = only do certain steps, not allowed with skip-steps
 694                               lists can be comma, colon, or space separated
 695
 696 Default branch is HEAD. Usually only the --config option should be necessary.
 697
 698 !;
 699     exit(0);
 700 }
 701
 702 sub time_str
 703 {
 704     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
 705     return sprintf("[%.2d:%.2d:%.2d] ",$hour, $min, $sec);
 706 }
 707
 708 sub step_wanted
 709 {
 710     my $step = shift;
 711     return $only_steps{$step} if $only_steps;
 712     return !$skip_steps{$step} if $skip_steps;
 713     return 1; # default is everything is wanted
 714 }
 715
 716 sub register_module_hooks
 717 {
 718     my $who = shift;
 719     my $what = shift;
 720     while (my ($hook,$func) = each %$what)
 721     {
 722         $module_hooks{$hook} ||= [];
 723         push(@{$module_hooks{$hook}},[$func,$who]);
 724     }
 725 }
 726
 727 sub process_module_hooks
 728 {
 729     my $hook = shift;
 730
 731     # pass remaining args (if any) to module func
 732     foreach my $module (@{$module_hooks{$hook}})
 733     {
 734         my ($func,$module_instance) = @$module;
 735         &$func($module_instance, @_);
 736     }
 737 }
 738
 739 sub check_optional_step
 740 {
 741     my $step = shift;
 742     my $oconf;
 743     my $shandle;
 744
 745     return undef unless ref($oconf = $optional_steps->{$step});
 746     if ($oconf->{branches})
 747     {
 748         return undef unless grep {$_ eq $branch} @{$oconf->{branches}};
 749     }
 750
 751     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =localtime(time);
 752     return undef if (exists $oconf->{min_hour} &&  $hour < $oconf->{min_hour});
 753     return undef if (exists $oconf->{max_hour} &&  $hour > $oconf->{max_hour});
 754     return undef if (exists $oconf->{dow}
 755         &&grep {$_ eq $wday} @{$oconf->{dow}});
 756
 757     my $last_step = $last_status = find_last("$step") || 0;
 758
 759     return undef unless ($forcerun ||
 760                          time >$last_step + (3600 * $oconf->{min_hours_since}));
 761     set_last("$step") unless $nostatus;
 762
 763     return 1;
 764 }
 765
 766 sub clean_from_source
 767 {
 768     if (-e "$exim/GNUmakefile")
 769     {
 770
 771         # fixme for MSVC
 772         my @makeout = `cd $exim && $make distclean 2>&1`;
 773         my $status = $? >>8;
 774         writelog('distclean',\@makeout);
 775         print "======== distclean log ===========\n",@makeout if ($verbose > 1);
 776         send_result('distclean',$status,\@makeout) if $status;
 777     }
 778 }
 779
 780 sub interrupt_exit
 781 {
 782     my $signame = shift;
 783     print "Exiting on signal $signame\n";
 784     exit(1);
 785 }
 786
 787 sub cleanlogs
 788 {
 789     my $lrname = $st_prefix . $logdirname;
 790     rmtree("$lrname");
 791     mkdir "$lrname" || die "can't make $lrname dir: $!";
 792 }
 793
 794 sub writelog
 795 {
 796     my $stage = shift;
 797     my $loglines = shift;
 798     my $handle;
 799     my $lrname = $st_prefix . $logdirname;
 800     open($handle,">$lrname/$stage.log") || die $!;
 801     print $handle @$loglines;
 802     close($handle);
 803 }
 804
 805 sub display_features
 806 {
 807     return unless step_wanted('features');
 808     my @out = `cd $exim
 809                src/build-*/exim -C test/confs/0000 -bV `;
 810     my $status = $? >>8;
 811     writelog('features',\@out);
 812     print "======== features log ===========\n",@out if ($verbose > 1);
 813     send_result('Features',$status,\@out) if $status;
 814     $steps_completed .= " Features";
 815 }
 816
 817 sub check_make
 818 {
 819     my @out = `$make -v 2>&1`;
 820     return undef unless ($? == 0 && grep {/GNU Make/} @out);
 821     return 'OK';
 822 }
 823
 824 sub make
 825 {
 826     return unless step_wanted('make');
 827     print time_str(),"running make ...\n" if $verbose;
 828     my $make_args = join(' ',$EximBuild::conf{make_args});
 829     my (@makeout);
 830     my $make_cmd = $make;
 831     $make_cmd = "$make -j $make_jobs"
 832       if ($make_jobs > 1 && ($branch eq 'HEAD' || $branch ge 'REL9_1'));
 833     @makeout = `cd $exim/src && $make_cmd $make_args 2>&1`;
 834     my $status = $? >>8;
 835     writelog('make',\@makeout);
 836     print "======== make log ===========\n",@makeout if ($verbose > 1);
 837     send_result('Make',$status,\@makeout) if $status;
 838     $steps_completed .= " Make";
 839 }
 840
 841 sub make_doc
 842 {
 843     return unless step_wanted('make-doc');
 844     print time_str(),"running make doc ...\n" if $verbose;
 845
 846     my (@makeout);
 847     @makeout = `cd $exim/doc/doc-docbook/ && \
 848                 EXIM_VER="4.82" $make everything 2>&1`;
 849     my $status = $? >>8;
 850     writelog('make-doc',\@makeout);
 851     print "======== make doc log ===========\n",@makeout if ($verbose > 1);
 852     send_result('Doc',$status,\@makeout) if $status;
 853     $steps_completed .= " Doc";
 854 }
 855
 856 sub get_stack_trace
 857 {
 858     my $bindir = shift;
 859     my $pgdata = shift;
 860
 861     # no core = no result
 862     my @cores = glob("$pgdata/$core_file_glob");
 863     return () unless @cores;
 864
 865     # no gdb = no result
 866     system "gdb --version > $devnull 2>&1";
 867     my $status = $? >>8;
 868     return () if $status;
 869
 870     my $cmdfile = "./gdbcmd";
 871     my $handle;
 872     open($handle, ">$cmdfile");
 873     print $handle "bt\n";
 874     close($handle);
 875
 876     my @trace;
 877
 878     foreach my $core (@cores)
 879     {
 880         my @onetrace = `gdb -x $cmdfile --batch $bindir/exim $core 2>&1`;
 881         push(@trace,
 882             "\n\n================== stack trace: $core ==================\n",
 883             @onetrace);
 884     }
 885
 886     unlink $cmdfile;
 887
 888     return @trace;
 889 }
 890
 891 sub make_install_check
 892 {
 893     my $locale = shift;
 894     return unless step_wanted('install-check');
 895     print time_str(),"running make installcheck ($locale)...\n" if $verbose;
 896
 897     my @checklog;
 898     unless ($using_msvc)
 899     {
 900         @checklog = `cd $exim/src/test/regress && $make installcheck 2>&1`;
 901     }
 902     else
 903     {
 904         chdir "$exim/src/tools/msvc";
 905         @checklog = `perl vcregress.pl installcheck 2>&1`;
 906         chdir $branch_root;
 907     }
 908     my $status = $? >>8;
 909     my @logfiles =
 910       ("$exim/src/test/regress/regression.diffs","$installdir/logfile");
 911     foreach my $logfile(@logfiles)
 912     {
 913         next unless (-e $logfile );
 914         push(@checklog,"\n\n================== $logfile ==================\n");
 915         my $handle;
 916         open($handle,$logfile);
 917         while(<$handle>)
 918         {
 919             push(@checklog,$_);
 920         }
 921         close($handle);
 922     }
 923     if ($status)
 924     {
 925         my @trace =
 926           get_stack_trace("$installdir/bin","$installdir/data-$locale");
 927         push(@checklog,@trace);
 928     }
 929     writelog("install-check-$locale",\@checklog);
 930     print "======== make installcheck log ===========\n",@checklog
 931       if ($verbose > 1);
 932     send_result("InstallCheck-$locale",$status,\@checklog) if $status;
 933     $steps_completed .= " InstallCheck-$locale";
 934 }
 935
 936 sub make_isolation_check
 937 {
 938     my $locale = shift;
 939     return unless step_wanted('isolation-check');
 940     my @makeout;
 941     unless ($using_msvc)
 942     {
 943         my $cmd =
 944           "cd $exim/src/test/isolation && $make NO_LOCALE=1 installcheck";
 945         @makeout = `$cmd 2>&1`;
 946     }
 947     else
 948     {
 949         chdir "$exim/src/tools/msvc";
 950         @makeout = `perl vcregress.pl isolationcheck 2>&1`;
 951         chdir $branch_root;
 952     }
 953
 954     my $status = $? >>8;
 955
 956     # get the log files and the regression diffs
 957     my @logs = glob("$exim/src/test/isolation/log/*.log");
 958     push(@logs,"$installdir/logfile");
 959     unshift(@logs,"$exim/src/test/isolation/regression.diffs")
 960       if (-e "$exim/src/test/isolation/regression.diffs");
 961     foreach my $logfile (@logs)
 962     {
 963         push(@makeout,"\n\n================== $logfile ===================\n");
 964         my $handle;
 965         open($handle,$logfile);
 966         while(<$handle>)
 967         {
 968             push(@makeout,$_);
 969         }
 970         close($handle);
 971     }
 972     if ($status)
 973     {
 974         my @trace =
 975           get_stack_trace("$installdir/bin","$installdir/data-$locale");
 976         push(@makeout,@trace);
 977     }
 978     writelog('isolation-check',\@makeout);
 979     print "======== make isolation check logs ===========\n",@makeout
 980       if ($verbose > 1);
 981
 982     send_result('IsolationCheck',$status,\@makeout) if $status;
 983     $steps_completed .= " IsolationCheck";
 984 }
 985
 986 sub make_test
 987 {
 988     return unless step_wanted('test');
 989     print time_str(),"running make test ...\n" if $verbose;
 990     my $tests_range = $EximBuild::conf{range_num_tests} || "1 4";
 991     my @makeout;
 992     @makeout =`(cd $exim/test
 993                 autoconf && ./configure && $make )2>&1 `;
 994     my $status = $? >>8;
 995     unless($status)
 996     {
 997       my @tmp = `(WORKDIR=\$PWD
 998                   cd $exim/test
 999                   ./runtest \$WORKDIR/$exim/src/build-*/exim -CONTINUE $tests_range )2>&1`;
1000       $status = $? >>8;
1001       push @makeout, @tmp;
1002     }
1003     writelog('test',\@makeout);
1004     print "======== make test logs ===========\n",@makeout
1005       if ($verbose > 1);
1006
1007     send_result('Test',$status,\@makeout) if $status;
1008     $steps_completed .= " Test";
1009 }
1010
1011 sub make_ecpg_check
1012 {
1013     return unless step_wanted('ecpg-check');
1014     my @makeout;
1015     my $ecpg_dir = "$exim/src/interfaces/ecpg";
1016     if ($using_msvc)
1017     {
1018         chdir "$exim/src/tools/msvc";
1019         @makeout = `perl vcregress.pl ecpgcheck 2>&1`;
1020         chdir $branch_root;
1021     }
1022     else
1023     {
1024         @makeout = `cd  $ecpg_dir && $make NO_LOCALE=1 check 2>&1`;
1025     }
1026     my $status = $? >>8;
1027
1028     # get the log files and the regression diffs
1029     my @logs = glob("$ecpg_dir/test/log/*.log");
1030     unshift(@logs,"$ecpg_dir/test/regression.diffs")
1031       if (-e "$ecpg_dir/test/regression.diffs");
1032     foreach my $logfile (@logs)
1033     {
1034         push(@makeout,"\n\n================== $logfile ===================\n");
1035         my $handle;
1036         open($handle,$logfile);
1037         while(<$handle>)
1038         {
1039             push(@makeout,$_);
1040         }
1041         close($handle);
1042     }
1043     if ($status)
1044     {
1045         my $base = "$ecpg_dir/test/regress/tmp_check";
1046         my @trace =
1047           get_stack_trace("$base/install$installdir/bin",       "$base/data");
1048         push(@makeout,@trace);
1049     }
1050     writelog('ecpg-check',\@makeout);
1051     print "======== make ecpg check logs ===========\n",@makeout
1052       if ($verbose > 1);
1053
1054     send_result('ECPG-Check',$status,\@makeout) if $status;
1055     $steps_completed .= " ECPG-Check";
1056 }
1057
1058 sub configure
1059 {
1060     return unless step_wanted('configure');
1061     print time_str(),"creating configuration ...\n" if $verbose;
1062
1063     my $env = $EximBuild::conf{makefile_set};
1064     my $add = $EximBuild::conf{makefile_add};
1065     my $features = $EximBuild::conf{makefile_regex};
1066
1067     my $envstr = "";
1068     while (my ($key,$val) = each %$env)
1069     {
1070         $envstr .= "$key='$val'\n";
1071     }
1072     while (my ($key,$val) = each %$add)
1073     {
1074         $envstr .= "$key+='$val'\n";
1075     }
1076
1077     my $conf_path = "src/src/EDITME";
1078     my $local_conf = "src/Local/Makefile";
1079     my @confout = `cd $exim; mkdir -p src/Local 2>&1`;
1080     my @tmp = `cd $exim && cp $conf_path $local_conf 2>&1`;
1081     my $status = $? >> 8;
1082     push @confout, @tmp;
1083     if ($status == 0)
1084     {
1085         # First, let's display some directory permissions in case
1086         # permissions are causing problems.
1087         my @dir = split('/',`pwd`);
1088         chomp(@dir);
1089         my $count = scalar @dir;
1090         my $loop = 1;
1091         my $dirs = '';
1092         while ($loop < $count)
1093         {
1094           my $dir = "";
1095           foreach my $i (0 .. $loop)
1096           {
1097             $dir .= $dir[$i].'/';
1098           }
1099           $dirs .= " $dir";
1100           $loop++;
1101         }
1102         @tmp = `echo "Verify Directory Permissions"
1103                 ls -ld $dirs`;
1104         push @confout, @tmp;
1105         # Build the config file from the EDITME template
1106         @tmp = `cd $exim && echo '$envstr' >> $local_conf`;
1107         push @confout, @tmp;
1108         my $exim_user = $EximBuild::conf{master_exim_user} || 'exim';
1109         @tmp = `echo "Hardcoded Exim user info:"; id $exim_user
1110           cd $exim && perl -pi -e 's/^EXIM_USER=.*/EXIM_USER=$exim_user/' $local_conf`;
1111         push @confout, @tmp;
1112         my $me = `whoami`; chomp $me;
1113         @tmp = `echo "Build Farm user info:"; id $me
1114           cd $exim && perl -pi -e 's/^# CONFIGURE_OWNER=\$/CONFIGURE_OWNER=$me/' $local_conf`;
1115         push @confout, @tmp;
1116         @tmp = `cd $exim && perl -pi -e 's/^# TRUSTED_CONFIG_LIST=/TRUSTED_CONFIG_LIST=/' $local_conf`;
1117         push @confout, @tmp;
1118         @tmp = `cd $exim && perl -pi -e 's/^# WHITELIST_D_MACROS=.*/WHITELIST_D_MACROS=DIR:EXIM_PATH:AA:ACL:ACLRCPT:ACL_MAIL:ACL_PREDATA:ACL_RCPT:AFFIX:ALLOW:ARG1:ARG2:AUTHF:AUTHS:AUTH_ID_DOMAIN:BAD:BANNER:BB:BR:BRB:CERT:COM:COMMAND_USER:CONNECTCOND:CONTROL:CREQCIP:CREQMAC:CRL:CSS:D6:DATA:DCF:DDF:DEFAULTDWC:DELAY:DETAILS:DRATELIMIT:DYNAMIC_OPTION:ELI:ERROR_DETAILS:ERT:FAKE:FALLBACK:FILTER:FILTER_PREPEND_HOME:FORBID:FORBID_SMTP_CODE:FUSER:HAI:HAP:HARDLIMIT:HEADER_LINE_MAXSIZE:HEADER_MAXSIZE:HELO_MSG:HL:HOSTS:HOSTS_AVOID_TLS:HOSTS_MAX_TRY:HVH:IFACE:IGNORE_QUOTA:INC:INSERT:IP1:IP2:LAST:LDAPSERVERS:LENCHECK:LIMIT:LIST:LOG_SELECTOR:LS:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:RT:S:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STD:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF:X:Y/' $local_conf`;
1119         push @confout, @tmp;
1120         @tmp = `cd $exim && perl -pi -e 's/^EXIM_MONITOR=(.*)/# EXIM_MONITOR=\$1/' $local_conf`;
1121         push @confout, @tmp;
1122         for my $regex ( @$features )
1123         {
1124             @tmp = `cd $exim
1125                     perl -pi -e '$regex' $local_conf 2>&1
1126                     echo "Used regex: $regex" `;
1127             push @confout, @tmp;
1128         }
1129         # Add the final build file to the display output
1130         @tmp = `cd $exim
1131                 echo
1132                 echo "Contents of Local/Makefile:"
1133                 egrep '^[^#]' $local_conf `;
1134         push @confout, @tmp;
1135         # Build the config_opts array to send to the server
1136         chomp @tmp;
1137         my @config_opts = grep s/(?:LOOKUP_|EXPERIMENTAL_|USE_)(\S+)=.*/$1/,
1138                           @tmp;
1139         push @config_opts, grep s/^(?:EXIM_)(PERL|PYTHON)=.*/$1/,
1140                            @tmp;
1141         $EximBuild::conf{config_opts} = \@config_opts;
1142
1143         # Does not matter what the Exim version is, as long as it is valid.
1144         my $exim_ver = $EximBuild::conf{exim_test_version} || '4.82';
1145         `cd $exim
1146          echo 'EXIM_RELEASE_VERSION="$exim_ver"' > src/src/version.sh
1147          echo 'EXIM_VARIANT_VERSION=""' >> src/src/version.sh
1148          echo 'EXIM_COMPILE_NUMBER="0"' >> src/src/version.sh`;
1149     }
1150
1151     print "======== configure output ===========\n",@confout
1152       if ($verbose > 1);
1153
1154     writelog('configure',\@confout);
1155
1156     if ($status)
1157     {
1158         send_result('Configure',$status,\@confout);
1159     }
1160
1161     $steps_completed .= " Configure";
1162 }
1163
1164 sub find_last
1165 {
1166     my $which = shift;
1167     my $stname = $st_prefix . "last.$which";
1168     my $handle;
1169     open($handle,$stname) or return undef;
1170     my $time = <$handle>;
1171     close($handle);
1172     chomp $time;
1173     return $time + 0;
1174 }
1175
1176 sub set_last
1177 {
1178     my $which = shift;
1179     my $stname = $st_prefix . "last.$which";
1180     my $st_now = shift || time;
1181     my $handle;
1182     open($handle,">$stname") or die "opening $stname: $!";
1183     print $handle "$st_now\n";
1184     close($handle);
1185 }
1186
1187 sub send_result
1188 {
1189
1190     # clean up temp file
1191     $extraconf = undef;
1192
1193     my $stage = shift;
1194
1195     my $ts = $now || time;
1196     my $status=shift || 0;
1197     my $log = shift || [];
1198     print "======== log passed to send_result ===========\n",@$log
1199       if ($verbose > 1);
1200
1201     unshift(@$log,
1202         "Last file mtime in snapshot: ",
1203         scalar(gmtime($current_snap)),
1204         " GMT\n","===================================================\n")
1205       unless ($from_source || !$current_snap);
1206
1207     my $log_data = join("",@$log);
1208     my $confsum = "";
1209     my $changed_this_run = "";
1210     my $changed_since_success = "";
1211     $changed_this_run = join("!",@changed_files)
1212       if @changed_files;
1213     $changed_since_success = join("!",@changed_since_success)
1214       if ($stage ne 'OK' && @changed_since_success);
1215
1216     if ($stage eq 'OK')
1217     {
1218         $confsum= $saved_config;
1219     }
1220     elsif ($stage !~ /CVS|Git|SCM/ )
1221     {
1222         $confsum = get_config_summary();
1223     }
1224     else
1225     {
1226         $confsum = get_script_config_dump();
1227     }
1228
1229     my $savedata = Data::Dumper->Dump(
1230         [
1231             $changed_this_run, $changed_since_success, $branch, $status,$stage,
1232             $animal, $ts,$log_data, $confsum, $target, $verbose, $secret
1233         ],
1234         [
1235             qw(changed_this_run changed_since_success branch status stage
1236               animal ts log_data confsum target verbose secret)
1237         ]
1238     );
1239
1240     my $lrname = $st_prefix . $logdirname;
1241
1242     # might happen if there is a CVS failure and have never got further
1243     mkdir $lrname unless -d $lrname;
1244
1245     my $txfname = "$lrname/web-txn.data";
1246     my $txdhandle;
1247     open($txdhandle,">$txfname");
1248     print $txdhandle $savedata;
1249     close($txdhandle);
1250
1251     if ($nosend || $stage eq 'CVS' || $stage eq 'CVS-status' )
1252     {
1253         print "Branch: $branch\n";
1254         if ($stage eq 'OK')
1255         {
1256             print "All stages succeeded\n";
1257             set_last('success.snap',$current_snap) unless $nostatus;
1258             exit(0);
1259         }
1260         else
1261         {
1262             print "Stage $stage failed with status $status\n";
1263             exit(1);
1264         }
1265     }
1266
1267     if ($stage !~ /CVS|Git|SCM|Pre-run-port-check/ )
1268     {
1269
1270         my @logfiles = glob("$lrname/*.log");
1271         my %mtimes = map { $_ => (stat $_)[9] } @logfiles;
1272         @logfiles =
1273           map { basename $_ }( sort { $mtimes{$a} <=> $mtimes{$b} } @logfiles );
1274         my $logfiles = join(' ',@logfiles);
1275         $tar_log_cmd =~ s/\*\.log/$logfiles/;
1276         chdir($lrname);
1277         system("$tar_log_cmd 2>&1 ");
1278         chdir($branch_root);
1279
1280     }
1281     else
1282     {
1283
1284         # these would be from an earlier run, since we
1285         # do cleanlogs() after the cvs stage
1286         # so don't send them.
1287         unlink "$lrname/runlogs.tgz";
1288     }
1289
1290     my $txstatus;
1291
1292     # this should now only apply to older Msys installs. All others should
1293     # be running with perl >= 5.8 since that's required to build exim
1294     # anyway
1295     if (!$^V or $^V lt v5.8.0)
1296     {
1297
1298         unless (-x "$aux_path/run_web_txn.pl")
1299         {
1300             print "Could not locate $aux_path/run_web_txn.pl\n";
1301             exit(1);
1302         }
1303
1304         system("$aux_path/run_web_txn.pl $lrname");
1305         $txstatus = $? >> 8;
1306     }
1307     else
1308     {
1309         $txstatus = EximBuild::WebTxn::run_web_txn($lrname) ? 0 : 1;
1310
1311     }
1312
1313     if ($txstatus)
1314     {
1315         print "Web txn failed with status: $txstatus\n";
1316
1317         # if the web txn fails, restore the timestamps
1318         # so we try again the next time.
1319         set_last('status',$last_status) unless $nostatus;
1320         set_last('run.snap',$last_run_snap) unless $nostatus;
1321         exit($txstatus);
1322     }
1323
1324     unless ($stage eq 'OK' || $quiet)
1325     {
1326         print "BuildFarm member $animal failed on $branch stage $stage\n";
1327     }
1328
1329     #   print "Success!\n",$response->content
1330     #           if $print_success;
1331
1332     set_last('success.snap',$current_snap) if ($stage eq 'OK' && !$nostatus);
1333
1334     exit 0;
1335 }
1336
1337 sub get_config_summary
1338 {
1339     my $handle;
1340     my $config = "";
1341     # unless ($using_msvc)
1342     # {
1343     #     open($handle,"$exim/config.log") || return undef;
1344     #     my $start = undef;
1345     #     while (<$handle>)
1346     #     {
1347     #         if (!$start && /created by PostgreSQL configure/)
1348     #         {
1349     #             $start=1;
1350     #             s/It was/This file was/;
1351     #         }
1352     #         next unless $start;
1353     #         last if /Core tests/;
1354     #         next if /^\#/;
1355     #         next if /= <?unknown>?/;
1356
1357     #         # split up long configure line
1358     #         if (m!\$.*configure.*--with! && length > 70)
1359     #         {
1360     #             my $pos = index($_," ",70);
1361     #             substr($_,$pos+1,0,"\\\n        ") if ($pos > 0);
1362     #             $pos = index($_," ",140);
1363     #             substr($_,$pos+1,0,"\\\n        ") if ($pos > 0);
1364     #             $pos = index($_," ",210);
1365     #             substr($_,$pos+1,0,"\\\n        ") if ($pos > 0);
1366     #         }
1367     #         $config .= $_;
1368     #     }
1369     #     close($handle);
1370     #     $config .=
1371     #       "\n========================================================\n";
1372     # }
1373     $config .= get_script_config_dump();
1374     return $config;
1375 }
1376
1377 sub get_script_config_dump
1378 {
1379     my $conf = {
1380         %EximBuild::conf,  # shallow copy
1381         script_version => $VERSION,
1382         invocation_args => \@invocation_args,
1383         steps_completed => $steps_completed,
1384         orig_env => $orig_env,
1385     };
1386     delete $conf->{secret};
1387     $Data::Dumper::Sortkeys = 1;
1388     return  Data::Dumper->Dump([$conf],['Script_Config']);
1389 }
1390
1391 sub scm_timeout
1392 {
1393     my $wait_time = shift;
1394     my $who_to_kill = getpgrp(0);
1395     my $sig = SIGTERM;
1396     $sig = -$sig;
1397     print "waiting $wait_time secs to time out process $who_to_kill\n"
1398       if $verbose;
1399     foreach my $sig (qw(INT TERM HUP QUIT))
1400     {
1401         $SIG{$sig}='DEFAULT';
1402     }
1403     sleep($wait_time);
1404     $SIG{TERM} = 'IGNORE'; # so we don't kill ourself, we're exiting anyway
1405     # kill the whole process group
1406     unless (kill $sig,$who_to_kill)
1407     {
1408         print "scm timeout kill failed\n";
1409     }
1410 }
1411
1412 sub spawn
1413 {
1414     my $coderef = shift;
1415     my $pid = fork;
1416     if (defined($pid) && $pid == 0)
1417     {
1418         exit &$coderef(@_);
1419     }
1420     return $pid;
1421 }
1422