t/run.perl

   1 #!/usr/bin/perl -w
   2 # Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
   3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   4 #
   5 # Parallel test runner which preloads code and reuses worker processes
   6 # to give a nice speedup over prove(1).  It also generates per-test
   7 # .log files (similar to automake tests).
   8 #
   9 # *.t files run by this should not rely on global state.
  10 #
  11 # Usage: $PERL -I lib -w t/run.perl -j4
  12 # Or via prove(1): prove -lvw t/run.perl :: -j4
  13 use strict;
  14 use v5.10.1;
  15 use IO::Handle; # ->autoflush
  16 use PublicInbox::TestCommon;
  17 use Cwd qw(getcwd);
  18 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
  19 use Errno qw(EINTR);
  20 use Fcntl qw(:seek);
  21 use POSIX qw(_POSIX_PIPE_BUF WNOHANG);
  22 my $jobs = 1;
  23 my $repeat = 1;
  24 $| = 1;
  25 our $log_suffix = '.log';
  26 my ($shuffle, %pids, @err);
  27 GetOptions('j|jobs=i' => \$jobs,
  28         'repeat=i' => \$repeat,
  29         'log=s' => \$log_suffix,
  30         's|shuffle' => \$shuffle,
  31 ) or die "Usage: $0 [-j JOBS] [--log=SUFFIX] [--repeat RUNS]";
  32 if (($ENV{TEST_RUN_MODE} // 2) == 0) {
  33         die "$0 is not compatible with TEST_RUN_MODE=0\n";
  34 }
  35 my @tests = scalar(@ARGV) ? @ARGV : glob('t/*.t');
  36 my $cwd = getcwd();
  37 open my $OLDOUT, '>&STDOUT' or die "dup STDOUT: $!";
  38 open my $OLDERR, '>&STDERR' or die "dup STDERR: $!";
  39 $OLDOUT->autoflush(1);
  40 $OLDERR->autoflush(1);
  41
  42 key2sub($_) for @tests; # precache
  43
  44 if ($shuffle) {
  45         require List::Util;
  46 } elsif (open(my $prove_state, '<', '.prove') && eval { require YAML::XS }) {
  47         # reuse "prove --state=save" data to start slowest tests, first
  48         my $state = YAML::XS::Load(do { local $/; <$prove_state> });
  49         my $t = $state->{tests};
  50         @tests = sort {
  51                 ($t->{$b}->{elapsed} // 0) <=> ($t->{$a}->{elapsed} // 0)
  52         } @tests;
  53 }
  54
  55 our $tb = Test::More->builder;
  56
  57 sub DIE (;$) {
  58         print $OLDERR @_;
  59         exit(1);
  60 }
  61
  62 our ($worker, $worker_test);
  63
  64 sub test_status () {
  65         $? = 255 if $? == 0 && !$tb->is_passing;
  66         my $status = $? ? 'not ok' : 'ok';
  67         chdir($cwd) or DIE "chdir($cwd): $!";
  68         if ($log_suffix ne '') {
  69                 my $log = $worker_test;
  70                 $log =~ s/\.t\z/$log_suffix/;
  71                 my $skip = '';
  72                 if (open my $fh, '<', $log) {
  73                         my @not_ok = grep(!/^(?:ok |[ \t]*#)/ms, <$fh>);
  74                         my $last = $not_ok[-1] // '';
  75                         pop @not_ok if $last =~ /^[0-9]+\.\.[0-9]+$/;
  76                         my $pfx = "# $log: ";
  77                         print $OLDERR map { $pfx.$_ } @not_ok;
  78                         seek($fh, 0, SEEK_SET) or die "seek: $!";
  79
  80                         # show unique skip texts and the number of times
  81                         # each text was skipped
  82                         local $/;
  83                         my @sk = (<$fh> =~ m/^ok [0-9]+ (# skip [^\n]+)/mgs);
  84                         if (@sk) {
  85                                 my %nr;
  86                                 my @err = grep { !$nr{$_}++ } @sk;
  87                                 print $OLDERR "$pfx$_ ($nr{$_})\n" for @err;
  88                                 $skip = ' # total skipped: '.scalar(@sk);
  89                         }
  90                 } else {
  91                         print $OLDERR "could not open: $log: $!\n";
  92                 }
  93                 print $OLDOUT "$status $worker_test$skip\n";
  94         }
  95 }
  96
  97 # Test::Builder or Test2::Hub may call exit() from plan(skip_all => ...)
  98 END { test_status() if (defined($worker_test) && $worker == $$) }
  99
 100 sub run_test ($) {
 101         my ($test) = @_;
 102         my $log_fh;
 103         if ($log_suffix ne '') {
 104                 my $log = $test;
 105                 $log =~ s/\.[^\.]+\z/$log_suffix/ or DIE "can't log for $test";
 106                 open $log_fh, '>', $log or DIE "open $log: $!";
 107                 $log_fh->autoflush(1);
 108                 $tb->output($log_fh);
 109                 $tb->failure_output($log_fh);
 110                 $tb->todo_output($log_fh);
 111                 open STDOUT, '>&', $log_fh or DIE "1>$log: $!";
 112                 open STDERR, '>&', $log_fh or DIE "2>$log: $!";
 113         }
 114         $worker_test = $test;
 115         run_script([$test]);
 116         test_status();
 117         $worker_test = undef;
 118         push @err, "$test ($?)" if $?;
 119 }
 120
 121 sub UINT_SIZE () { 4 }
 122
 123 # worker processes will SIGUSR1 the producer process when it
 124 # sees EOF on the pipe.  On FreeBSD 11.2 and Perl 5.30.0,
 125 # sys/ioctl.ph gives the wrong value for FIONREAD().
 126 my $producer = $$;
 127 my $eof; # we stop respawning if true
 128
 129 my $start_worker = sub {
 130         my ($i, $j, $rd, $todo) = @_;
 131         defined(my $pid = fork) or DIE "fork: $!";
 132         if ($pid == 0) {
 133                 $worker = $$;
 134                 while (1) {
 135                         my $r = sysread($rd, my $buf, UINT_SIZE);
 136                         if (!defined($r)) {
 137                                 next if $! == EINTR;
 138                                 DIE "sysread: $!";
 139                         }
 140                         last if $r == 0;
 141                         DIE "short read $r" if $r != UINT_SIZE;
 142                         my $t = unpack('I', $buf);
 143                         run_test($todo->[$t]);
 144                         $tb->reset;
 145                 }
 146                 kill 'USR1', $producer if !$eof; # sets $eof in $producer
 147                 DIE join('', map { "E: $_\n" } @err) if @err;
 148                 exit(0);
 149         } else {
 150                 $pids{$pid} = $j;
 151         }
 152 };
 153
 154 # negative $repeat means loop forever:
 155 for (my $i = $repeat; $i != 0; $i--) {
 156         my @todo = $shuffle ? List::Util::shuffle(@tests) : @tests;
 157
 158         # single-producer, multi-consumer queue relying on POSIX semantics
 159         pipe(my ($rd, $wr)) or DIE "pipe: $!";
 160
 161         # fill the queue before forking so children can start earlier
 162         my $n = (_POSIX_PIPE_BUF / UINT_SIZE);
 163         if ($n >= $#todo) {
 164                 print $wr join('', map { pack('I', $_) } (0..$#todo)) or DIE;
 165                 close $wr or die;
 166                 $wr = undef;
 167         } else { # write what we can...
 168                 $wr->autoflush(1);
 169                 print $wr join('', map { pack('I', $_) } (0..$n)) or DIE;
 170                 $n += 1; # and send more ($n..$#todo), later
 171         }
 172         $eof = undef;
 173         local $SIG{USR1} = sub { $eof = 1 };
 174         my $sigchld = sub {
 175                 my ($sig) = @_;
 176                 my $flags = $sig ? WNOHANG : 0;
 177                 while (1) {
 178                         my $pid = waitpid(-1, $flags) or return;
 179                         return if $pid < 0;
 180                         my $j = delete $pids{$pid};
 181                         if (!defined($j)) {
 182                                 push @err, "reaped unknown $pid ($?)";
 183                                 next;
 184                         }
 185                         push @err, "job[$j] ($?)" if $?;
 186                         # skip_all can exit(0), respawn if needed:
 187                         if (!$eof) {
 188                                 print $OLDERR "# respawning job[$j]\n";
 189                                 $start_worker->($i, $j, $rd, \@todo);
 190                         }
 191                 }
 192         };
 193
 194         # start the workers to consume the queue
 195         for (my $j = 0; $j < $jobs; $j++) {
 196                 $start_worker->($i, $j, $rd, \@todo);
 197         }
 198
 199         if ($wr) {
 200                 local $SIG{CHLD} = $sigchld;
 201                 # too many tests to fit in the pipe before starting workers,
 202                 # send the rest now the workers are running
 203                 print $wr join('', map { pack('I', $_) } ($n..$#todo)) or DIE;
 204                 close $wr or die;
 205         }
 206
 207         $sigchld->(0) while scalar(keys(%pids));
 208         DIE join('', map { "E: $_\n" } @err) if @err;
 209 }
 210
 211 print $OLDOUT "1..".($repeat * scalar(@tests))."\n" if $repeat >= 0;