]> git.sur5r.net Git - i3/i3/blobdiff - testcases/complete-run.pl
Merge branch 'master' into next
[i3/i3] / testcases / complete-run.pl
index 915a7e02679a1978cca5ab156ac0c5e22103650f..c62623f10245ae29ceab38165ed1c01156f62d49 100755 (executable)
@@ -7,7 +7,6 @@ use warnings;
 use v5.10;
 # the following are modules which ship with Perl (>= 5.10):
 use Pod::Usage;
-use Carp::Always;
 use Cwd qw(abs_path);
 use File::Basename qw(basename);
 use File::Temp qw(tempfile tempdir);
@@ -22,12 +21,18 @@ use TAP::Parser::Aggregator;
 use lib qw(lib);
 use SocketActivation;
 use StartXDummy;
+use StatusLine;
 # the following modules are not shipped with Perl
 use AnyEvent;
+use AnyEvent::Util;
 use AnyEvent::Handle;
 use AnyEvent::I3 qw(:all);
 use X11::XCB;
 
+# Close superfluous file descriptors which were passed by running in a VIM
+# subshell or situations like that.
+AnyEvent::Util::close_all_fds_except(0, 1, 2);
+
 # We actually use AnyEvent to make sure it loads an event loop implementation.
 # Afterwards, we overwrite SIGCHLD:
 my $cv = AnyEvent->condvar;
@@ -45,8 +50,13 @@ sub slurp {
     <$fh>;
 }
 
+# convinience wrapper to write to the log file
+my $log;
+sub Log { say $log "@_" }
+
 my $coverage_testing = 0;
 my $valgrind = 0;
+my $strace = 0;
 my $help = 0;
 # Number of tests to run in parallel. Important to know how many Xdummy
 # instances we need to start (unless @displays are given). Defaults to
@@ -58,6 +68,7 @@ my @childpids = ();
 my $result = GetOptions(
     "coverage-testing" => \$coverage_testing,
     "valgrind" => \$valgrind,
+    "strace" => \$strace,
     "display=s" => \@displays,
     "parallel=i" => \$parallel,
     "help|?" => \$help,
@@ -86,7 +97,7 @@ for my $display (@displays) {
     my $screen;
     my $x = X11::XCB->new($display, $screen);
     if ($x->has_error) {
-        say STDERR "WARNING: Not using X11 display $display, could not connect";
+        Log "WARNING: Not using X11 display $display, could not connect";
     } else {
         push @conns, $x;
         push @wdisplays, $display;
@@ -112,6 +123,10 @@ mkdir($outdir) or die "Could not create $outdir";
 unlink("latest") if -e "latest";
 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
 
+my $logfile = "$outdir/complete-run.log";
+open $log, '>', $logfile or die "Could not create '$logfile': $!";
+say "Writing logfile to '$logfile'...";
+
 # 3: run all tests
 my @done;
 my $num = @testfiles;
@@ -120,9 +135,11 @@ my $harness = TAP::Harness->new({ });
 my $aggregator = TAP::Parser::Aggregator->new();
 $aggregator->start();
 
+status_init(displays => \@wdisplays, tests => $num);
+
 # We start tests concurrently: For each display, one test gets started. Every
 # test starts another test after completing.
-take_job($_) for @wdisplays;
+for (@wdisplays) { $cv->begin; take_job($_) }
 
 #
 # Takes a test from the beginning of @testfiles and runs it.
@@ -137,12 +154,14 @@ take_job($_) for @wdisplays;
 sub take_job {
     my ($display) = @_;
 
-    my $test = shift @testfiles;
-    return unless $test;
+    my $test = shift @testfiles
+        or return $cv->end;
+
     my $dont_start = (slurp($test) =~ /# !NO_I3_INSTANCE!/);
-    my $logpath = "$outdir/i3-log-for-" . basename($test);
+    my $basename = basename($test);
+    my $logpath = "$outdir/i3-log-for-$basename";
 
-    my ($fh, $tmpfile) = tempfile('i3-run-cfg.XXXXXX', UNLINK => 1);
+    my ($fh, $tmpfile) = tempfile("i3-cfg-for-$basename.XXXXXX", UNLINK => 1);
     say $fh $config;
     say $fh "ipc-socket /tmp/nested-$display";
     close($fh);
@@ -159,14 +178,15 @@ sub take_job {
             display => $display,
             configfile => $tmpfile,
             outdir => $outdir,
-            logpath => $logpath,
+            testname => $basename,
             valgrind => $valgrind,
+            strace => $strace,
             cv => $activate_cv
         );
 
         my $child_watcher;
         $child_watcher = AnyEvent->child(pid => $pid, cb => sub {
-            say "child died. pid = $pid";
+            Log status($display, "child died. pid = $pid");
             undef $child_watcher;
         });
     }
@@ -184,7 +204,7 @@ sub take_job {
         # files are not written) and fallback to killing it
         if ($coverage_testing || $valgrind) {
             my $exited = 0;
-            say "[$display] Exiting i3 cleanly...";
+            Log status($display, 'Exiting i3 cleanly...');
             my $i3 = i3("/tmp/nested-$display");
             $i3->connect->cb(sub {
                 if (!$_[0]->recv) {
@@ -199,6 +219,8 @@ sub take_job {
                 }
             });
         } else {
+            Log status($display, 'killing i3');
+
             # No coverage testing or valgrind? Just kill -9 i3.
             kill(9, $pid) or die "Could not kill i3 using kill($pid)";
             $kill_cv->send();
@@ -214,21 +236,24 @@ sub take_job {
         my $start_duration = tv_interval($time_before_start, $time_activating);
         my ($status) = $activate_cv->recv;
         if ($dont_start) {
-            say "[$display] Not starting i3, testcase does that";
+            Log status($display, 'Not starting i3, testcase does that');
         } else {
-            say "[$display] i3 startup: took " . sprintf("%.2f", $start_duration) . "s, status = $status";
+            my $duration = sprintf("%.2f", $start_duration);
+            Log status($display, "i3 startup: took $duration sec, status = $status");
         }
 
-        say "[$display] Running $test with logfile $logpath";
+        Log status($display, "Starting $test");
 
         my $output;
         open(my $spool, '>', \$output);
         my $parser = TAP::Parser->new({
-            exec => [ 'sh', '-c', qq|DISPLAY=$display LOGPATH="$logpath" OUTDIR="$outdir" VALGRIND=$valgrind /usr/bin/perl -Ilib $test| ],
+            exec => [ 'sh', '-c', qq|DISPLAY=$display TESTNAME="$basename" OUTDIR="$outdir" VALGRIND=$valgrind STRACE=$strace /usr/bin/perl -Ilib $test| ],
             spool => $spool,
             merge => 1,
         });
 
+        my $tests_completed;
+
         my @watchers;
         my ($stdout, $stderr) = $parser->get_select_handles;
         for my $handle ($parser->get_select_handles) {
@@ -244,22 +269,26 @@ sub take_job {
 
                     my $result = $parser->next;
                     if (defined($result)) {
+                        $tests_completed++;
+                        status($display, "Running $test: [$tests_completed/??]");
                         # TODO: check if we should bail out
                         return;
                     }
 
                     # $result is not defined, we are done parsing
-                    say "[$display] $test finished";
+                    Log status($display, "$test finished");
                     close($parser->delete_spool);
                     $aggregator->add($test, $parser);
                     push @done, [ $test, $output ];
 
+                    status_completed(scalar @done);
+
                     my $exitcv = $kill_i3->();
                     $exitcv->cb(sub {
 
                         undef $_ for @watchers;
                         if (@done == $num) {
-                            $cv->send;
+                            $cv->end;
                         } else {
                             take_job($display);
                         }
@@ -275,18 +304,22 @@ $cv->recv;
 
 $aggregator->stop();
 
-# Disable buffering to make sure the output and summary appear before we exit.
-$| = 1;
+# print empty lines to seperate failed tests from statuslines
+print "\n\n";
 
 for (@done) {
     my ($test, $output) = @$_;
-    say "output for $test:";
-    say $output;
+    Log "output for $test:";
+    Log $output;
+    # print error messages of failed tests
+    say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
 }
 
 # 4: print summary
 $harness->summary($aggregator);
 
+close $log;
+
 kill(15, $_) for @childpids;
 
 __END__
@@ -329,7 +362,12 @@ complete-run.pl will start (num_cores * 2) Xdummy instances.
 =item B<--valgrind>
 
 Runs i3 under valgrind to find memory problems. The output will be available in
-C<latest/valgrind.log>.
+C<latest/valgrind-for-$test.log>.
+
+=item B<--strace>
+
+Runs i3 under strace to trace system calls. The output will be available in
+C<latest/strace-for-$test.log>.
 
 =item B<--coverage-testing>