X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=testcases%2Fcomplete-run.pl;h=915a7e02679a1978cca5ab156ac0c5e22103650f;hb=4cbb757408774eb20d40162fc400e2e14432583d;hp=6f00877cbf694e7b59582accbf2024db0e55f6bc;hpb=b4ab4703c9927f88a0ead3c0aa9df2a3155dc917;p=i3%2Fi3 diff --git a/testcases/complete-run.pl b/testcases/complete-run.pl index 6f00877c..915a7e02 100755 --- a/testcases/complete-run.pl +++ b/testcases/complete-run.pl @@ -1,71 +1,79 @@ #!/usr/bin/env perl # vim:ts=4:sw=4:expandtab -# # © 2010-2011 Michael Stapelberg and contributors -# -# syntax: ./complete-run.pl --display :1 --display :2 -# to run the test suite on the X11 displays :1 and :2 -# use 'Xdummy :1' and 'Xdummy :2' before to start two -# headless X11 servers -# use strict; use warnings; -use EV; -use AnyEvent; -use IO::Scalar; # not in core :\ -use File::Temp qw(tempfile tempdir); use v5.10; -use DateTime; -use Data::Dumper; +# the following are modules which ship with Perl (>= 5.10): +use Pod::Usage; +use Carp::Always; use Cwd qw(abs_path); -use Proc::Background; +use File::Basename qw(basename); +use File::Temp qw(tempfile tempdir); +use Getopt::Long; +use IO::Socket::UNIX; +use POSIX; +use Time::HiRes qw(sleep gettimeofday tv_interval); use TAP::Harness; use TAP::Parser; use TAP::Parser::Aggregator; -use File::Basename qw(basename); -use AnyEvent::I3 qw(:all); -use Try::Tiny; -use Getopt::Long; -use Time::HiRes qw(sleep); -use X11::XCB::Connection; -use IO::Socket::UNIX; # core -use POSIX; # core +# these are shipped with the testsuite +use lib qw(lib); +use SocketActivation; +use StartXDummy; +# the following modules are not shipped with Perl +use AnyEvent; use AnyEvent::Handle; +use AnyEvent::I3 qw(:all); +use X11::XCB; -# open a file so that we get file descriptor 3. we will later close it in the -# child and dup() the listening socket file descriptor to 3 to pass it to i3 -open(my $reserved, '<', '/dev/null'); -if (fileno($reserved) != 3) { - warn "Socket file descriptor is not 3."; - warn "Please don't start this script within a subshell of vim or something."; - exit 1; -} +# We actually use AnyEvent to make sure it loads an event loop implementation. +# Afterwards, we overwrite SIGCHLD: +my $cv = AnyEvent->condvar; -# install a dummy CHLD handler to overwrite the CHLD handler of AnyEvent / EV -# XXX: we could maybe also use a different loop than the default loop in EV? +# Install a dummy CHLD handler to overwrite the CHLD handler of AnyEvent. +# AnyEvent’s handler wait()s for every child which conflicts with TAP (TAP +# needs to get the exit status to determine if a test is successful). $SIG{CHLD} = sub { }; # reads in a whole file sub slurp { - open my $fh, '<', shift; + open(my $fh, '<', shift); local $/; <$fh>; } my $coverage_testing = 0; +my $valgrind = 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 +# num_cores * 2. +my $parallel = undef; my @displays = (); +my @childpids = (); my $result = GetOptions( "coverage-testing" => \$coverage_testing, + "valgrind" => \$valgrind, "display=s" => \@displays, + "parallel=i" => \$parallel, + "help|?" => \$help, ); +pod2usage(-verbose => 2, -exitcode => 0) if $help; + @displays = split(/,/, join(',', @displays)); @displays = map { s/ //g; $_ } @displays; -@displays = qw(:1) if @displays == 0; +# No displays specified, let’s start some Xdummy instances. +if (@displays == 0) { + my ($displays, $pids) = start_xdummy($parallel); + @displays = @$displays; + @childpids = @$pids; +} # connect to all displays for two reasons: # 1: check if the display actually works @@ -75,15 +83,18 @@ my $result = GetOptions( my @conns; my @wdisplays; for my $display (@displays) { - try { - my $x = X11::XCB::Connection->new(display => $display); + my $screen; + my $x = X11::XCB->new($display, $screen); + if ($x->has_error) { + say STDERR "WARNING: Not using X11 display $display, could not connect"; + } else { push @conns, $x; push @wdisplays, $display; - } catch { - say STDERR "WARNING: Not using X11 display $display, could not connect"; - }; + } } +die "No usable displays found" if @wdisplays == 0; + my $config = slurp('i3-test.config'); # 1: get a list of all testcases @@ -94,7 +105,7 @@ my @testfiles = @ARGV; # 2: create an output directory for this test-run my $outdir = "testsuite-"; -$outdir .= DateTime->now->strftime("%Y-%m-%d-%H-%M-%S-"); +$outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime()); $outdir .= `git describe --tags`; chomp($outdir); mkdir($outdir) or die "Could not create $outdir"; @@ -109,8 +120,6 @@ my $harness = TAP::Harness->new({ }); my $aggregator = TAP::Parser::Aggregator->new(); $aggregator->start(); -my $cv = AnyEvent->condvar; - # We start tests concurrently: For each display, one test gets started. Every # test starts another test after completing. take_job($_) for @wdisplays; @@ -133,117 +142,90 @@ sub take_job { my $dont_start = (slurp($test) =~ /# !NO_I3_INSTANCE!/); my $logpath = "$outdir/i3-log-for-" . basename($test); - my ($fh, $tmpfile) = tempfile(); + my ($fh, $tmpfile) = tempfile('i3-run-cfg.XXXXXX', UNLINK => 1); say $fh $config; say $fh "ipc-socket /tmp/nested-$display"; close($fh); my $activate_cv = AnyEvent->condvar; - my $start_i3 = sub { - # remove the old unix socket - unlink("/tmp/nested-$display-activation"); - - # pass all file descriptors up to three to the children. - # we need to set this flag before opening the socket. - open(my $fdtest, '<', '/dev/null'); - $^F = fileno($fdtest); - close($fdtest); - my $socket = IO::Socket::UNIX->new( - Listen => 1, - Local => "/tmp/nested-$display-activation", - ); + my $time_before_start = [gettimeofday]; - my $pid = fork; - if (!defined($pid)) { - die "could not fork()"; - } - say "pid = $pid"; - if ($pid == 0) { - say "child!"; - $ENV{LISTEN_PID} = $$; - $ENV{LISTEN_FDS} = 1; - $ENV{DISPLAY} = $display; - $^F = 3; - - say "fileno is " . fileno($socket); - close($reserved); - POSIX::dup2(fileno($socket), 3); - - # now execute i3 - my $i3cmd = abs_path("../i3") . " -V -d all --disable-signalhandler"; - my $cmd = "exec $i3cmd -c $tmpfile >$logpath 2>&1"; - exec "/bin/sh", '-c', $cmd; - - # if we are still here, i3 could not be found or exec failed. bail out. - exit 1; - } + my $pid; + if ($dont_start) { + $activate_cv->send(1); + } else { + $pid = activate_i3( + unix_socket_path => "/tmp/nested-$display-activation", + display => $display, + configfile => $tmpfile, + outdir => $outdir, + logpath => $logpath, + valgrind => $valgrind, + cv => $activate_cv + ); my $child_watcher; $child_watcher = AnyEvent->child(pid => $pid, cb => sub { say "child died. pid = $pid"; undef $child_watcher; }); - - # close the socket, the child process should be the only one which keeps a file - # descriptor on the listening socket. - $socket->close; - - # We now connect (will succeed immediately) and send a request afterwards. - # As soon as the reply is there, i3 is considered ready. - my $cl = IO::Socket::UNIX->new(Peer => "/tmp/nested-$display-activation"); - my $hdl; - $hdl = AnyEvent::Handle->new(fh => $cl, on_error => sub { $activate_cv->send(0) }); - - # send a get_tree message without payload - $hdl->push_write('i3-ipc' . pack("LL", 0, 4)); - - # wait for the reply - $hdl->push_read(chunk => 1, => sub { - my ($h, $line) = @_; - say "read something from i3"; - $activate_cv->send(1); - undef $hdl; - }); - - return $pid; - }; - - my $pid; - $pid = $start_i3->() unless $dont_start; + } my $kill_i3 = sub { + my $kill_cv = AnyEvent->condvar; + # Don’t bother killing i3 when we haven’t started it - return if $dont_start; + if ($dont_start) { + $kill_cv->send(); + return $kill_cv; + } # When measuring code coverage, try to exit i3 cleanly (otherwise, .gcda # files are not written) and fallback to killing it - if ($coverage_testing) { + if ($coverage_testing || $valgrind) { my $exited = 0; - try { - say "Exiting i3 cleanly..."; - i3("/tmp/nested-$display")->command('exit')->recv; - $exited = 1; - }; - return if $exited; + say "[$display] Exiting i3 cleanly..."; + my $i3 = i3("/tmp/nested-$display"); + $i3->connect->cb(sub { + if (!$_[0]->recv) { + # Could not connect to i3, just kill -9 it + kill(9, $pid) or die "Could not kill i3 using kill($pid)"; + $kill_cv->send(); + } else { + # Connected. Now send exit and continue once that’s acked. + $i3->command('exit')->cb(sub { + $kill_cv->send(); + }); + } + }); + } else { + # No coverage testing or valgrind? Just kill -9 i3. + kill(9, $pid) or die "Could not kill i3 using kill($pid)"; + $kill_cv->send(); } - say "[$display] killing i3"; - kill(9, $pid) or die "could not kill i3"; + return $kill_cv; }; # This will be called as soon as i3 is running and answered to our # IPC request $activate_cv->cb(sub { - say "cb"; + my $time_activating = [gettimeofday]; + my $start_duration = tv_interval($time_before_start, $time_activating); my ($status) = $activate_cv->recv; - say "complete-run: status = $status"; + if ($dont_start) { + say "[$display] Not starting i3, testcase does that"; + } else { + say "[$display] i3 startup: took " . sprintf("%.2f", $start_duration) . "s, status = $status"; + } say "[$display] Running $test with logfile $logpath"; my $output; + open(my $spool, '>', \$output); my $parser = TAP::Parser->new({ - exec => [ 'sh', '-c', "DISPLAY=$display /usr/bin/perl -It/lib $test" ], - spool => IO::Scalar->new(\$output), + exec => [ 'sh', '-c', qq|DISPLAY=$display LOGPATH="$logpath" OUTDIR="$outdir" VALGRIND=$valgrind /usr/bin/perl -Ilib $test| ], + spool => $spool, merge => 1, }); @@ -272,27 +254,30 @@ sub take_job { $aggregator->add($test, $parser); push @done, [ $test, $output ]; - $kill_i3->(); + my $exitcv = $kill_i3->(); + $exitcv->cb(sub { - undef $_ for @watchers; - if (@done == $num) { - $cv->send; - } else { - take_job($display); - } + undef $_ for @watchers; + if (@done == $num) { + $cv->send; + } else { + take_job($display); + } + }); } ); push @watchers, $w; } }); - - $activate_cv->send(1) if $dont_start; } $cv->recv; $aggregator->stop(); +# Disable buffering to make sure the output and summary appear before we exit. +$| = 1; + for (@done) { my ($test, $output) = @$_; say "output for $test:"; @@ -301,3 +286,59 @@ for (@done) { # 4: print summary $harness->summary($aggregator); + +kill(15, $_) for @childpids; + +__END__ + +=head1 NAME + +complete-run.pl - Run the i3 testsuite + +=head1 SYNOPSIS + +complete-run.pl [files...] + +=head1 EXAMPLE + +To run the whole testsuite on a reasonable number of Xdummy instances (your +running X11 will not be touched), run: + ./complete-run.pl + +To run only a specific test (useful when developing a new feature), run: + ./complete-run t/100-fullscreen.t + +=head1 OPTIONS + +=over 8 + +=item B<--display> + +Specifies which X11 display should be used. Can be specified multiple times and +will parallelize the tests: + + # Run tests on the second X server + ./complete-run.pl -d :1 + + # Run four tests in parallel on some Xdummy servers + ./complete-run.pl -d :1,:2,:3,:4 + +Note that it is not necessary to specify this anymore. If omitted, +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. + +=item B<--coverage-testing> + +Exits i3 cleanly (instead of kill -9) to make coverage testing work properly. + +=item B<--parallel> + +Number of Xdummy instances to start (if you don’t want to start num_cores * 2 +instances for some reason). + + # Run all tests on a single Xdummy instance + ./complete-run.pl -p 1