2 # vim:ts=4:sw=4:expandtab
3 # © 2010-2012 Michael Stapelberg and contributors
9 # the following are modules which ship with Perl (>= 5.10):
12 use File::Temp qw(tempfile tempdir);
17 use TAP::Parser::Aggregator;
18 use Time::HiRes qw(time);
20 # these are shipped with the testsuite
25 # the following modules are not shipped with Perl
29 use AnyEvent::I3 qw(:all);
30 use X11::XCB::Connection;
31 use JSON::XS; # AnyEvent::I3 depends on it, too.
33 binmode STDOUT, ':utf8';
34 binmode STDERR, ':utf8';
36 # Close superfluous file descriptors which were passed by running in a VIM
37 # subshell or situations like that.
38 AnyEvent::Util::close_all_fds_except(0, 1, 2);
40 # convinience wrapper to write to the log file
42 sub Log { say $log "@_" }
46 # Number of tests to run in parallel. Important to know how many Xephyr
47 # instances we need to start (unless @displays are given). Defaults to
58 my $keep_xserver_output = 0;
60 my $result = GetOptions(
61 "coverage-testing" => \$options{coverage},
62 "keep-xserver-output" => \$keep_xserver_output,
63 "valgrind" => \$options{valgrind},
64 "strace" => \$options{strace},
65 "xtrace" => \$options{xtrace},
66 "display=s" => \@displays,
67 "parallel=i" => \$parallel,
71 pod2usage(-verbose => 2, -exitcode => 0) if $help;
73 # Check for missing executables
77 ../i3-config-wizard/i3-config-wizard
78 ../i3-dump-log/i3-dump-log
81 ../i3-nagbar/i3-nagbar
84 foreach my $binary (@binaries) {
85 die "$binary executable not found, did you run “make”?" unless -e $binary;
86 die "$binary is not an executable" unless -x $binary;
89 qx(Xephyr -help 2>&1);
90 die "Xephyr was not found in your path. Please install Xephyr (xserver-xephyr on Debian)." if $?;
92 @displays = split(/,/, join(',', @displays));
93 @displays = map { s/ //g; $_ } @displays;
95 # 2: get a list of all testcases
96 my @testfiles = @ARGV;
98 # if no files were passed on command line, run all tests from t/
99 @testfiles = <t/*.t> if @testfiles == 0;
101 my $numtests = scalar @testfiles;
103 # No displays specified, let’s start some Xephyr instances.
104 if (@displays == 0) {
105 @displays = start_xserver($parallel, $numtests, $keep_xserver_output);
108 # 1: create an output directory for this test-run
109 my $outdir = "testsuite-";
110 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
111 $outdir .= `git describe --tags`;
113 mkdir($outdir) or die "Could not create $outdir";
114 unlink("latest") if -l "latest";
115 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
118 # connect to all displays for two reasons:
119 # 1: check if the display actually works
120 # 2: keep the connection open so that i3 is not the only client. this prevents
121 # the X server from exiting
123 for my $display (@displays) {
125 my $x = X11::XCB::Connection->new(display => $display);
127 die "Could not connect to display $display\n";
129 # start a TestWorker for each display
130 push @single_worker, worker($display, $x, $outdir, \%options);
134 # Read previous timing information, if available. We will be able to roughly
135 # predict the test duration and schedule a good order for the tests.
136 my $timingsjson = StartXServer::slurp('.last_run_timings.json');
137 %timings = %{decode_json($timingsjson)} if length($timingsjson) > 0;
139 # Re-order the files so that those which took the longest time in the previous
140 # run will be started at the beginning to not delay the whole run longer than
142 @testfiles = map { $_->[0] }
143 sort { $b->[1] <=> $a->[1] }
144 map { [$_, $timings{$_} // 999] } @testfiles;
146 # Run 000-load-deps.t first to bail out early when dependencies are missing.
147 my $loadtest = "t/000-load-deps.t";
148 if ((scalar grep { $_ eq $loadtest } @testfiles) > 0) {
149 @testfiles = ($loadtest, grep { $_ ne $loadtest } @testfiles);
152 printf("\nRough time estimate for this run: %.2f seconds\n\n", $timings{GLOBAL})
153 if exists($timings{GLOBAL});
155 # Forget the old timings, we don’t necessarily run the same set of tests as
156 # before. Otherwise we would end up with left-overs.
157 %timings = (GLOBAL => time());
159 my $logfile = "$outdir/complete-run.log";
160 open $log, '>', $logfile or die "Could not create '$logfile': $!";
162 say "Writing logfile to '$logfile'...";
166 my $num = @testfiles;
167 my $harness = TAP::Harness->new({ });
169 my $aggregator = TAP::Parser::Aggregator->new();
170 $aggregator->start();
172 status_init(displays => \@displays, tests => $num);
174 my $single_cv = AE::cv;
176 # We start tests concurrently: For each display, one test gets started. Every
177 # test starts another test after completing.
178 for (@single_worker) {
180 take_job($_, $single_cv, \@testfiles);
187 # print empty lines to seperate failed tests from statuslines
191 my ($test, $output) = @$_;
192 say "no output for $test" unless $output;
193 Log "output for $test:";
195 # print error messages of failed tests
196 say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
200 $harness->summary($aggregator);
204 # 5: Save the timings for better scheduling/prediction next run.
205 $timings{GLOBAL} = time() - $timings{GLOBAL};
206 open(my $fh, '>', '.last_run_timings.json');
207 print $fh encode_json(\%timings);
210 # 6: Print the slowest test files.
211 my @slowest = map { $_->[0] }
212 sort { $b->[1] <=> $a->[1] }
213 map { [$_, $timings{$_}] }
214 grep { !/^GLOBAL$/ } keys %timings;
216 say 'The slowest tests are:';
217 printf("\t%s with %.2f seconds\n", $_, $timings{$_})
218 for @slowest[0..($#slowest > 4 ? 4 : $#slowest)];
220 # When we are running precisely one test, print the output. Makes developing
221 # with a single testcase easier.
222 if ($numtests == 1) {
225 say StartXServer::slurp($logfile);
233 # Takes a test from the beginning of @testfiles and runs it.
235 # The TAP::Parser (which reads the test output) will get called as soon as
236 # there is some activity on the stdout file descriptor of the test process
237 # (using an AnyEvent->io watcher).
239 # When a test completes and @done contains $num entries, the $cv condvar gets
240 # triggered to finish testing.
243 my ($worker, $cv, $tests) = @_;
245 my $test = shift @$tests
248 my $display = $worker->{display};
250 Log status($display, "$test: starting");
251 $timings{$test} = time();
252 worker_next($worker, $test);
254 # create a TAP::Parser with an in-memory fh
256 my $parser = TAP::Parser->new({
257 source => do { open(my $fh, '<', \$output); $fh },
260 my $ipc = $worker->{ipc};
267 state $tests_completed = 0;
270 sysread($ipc, my $buf, 4096) or die "sysread: $!";
273 $buf = $partial . $buf;
277 # make sure we feed TAP::Parser complete lines so it doesn't blow up
278 if (substr($buf, -1, 1) ne "\n") {
279 my $nl = rindex($buf, "\n");
285 # strip partial from buffer
286 $partial = substr($buf, $nl + 1, '');
289 # count lines before stripping eof-marker otherwise we might
290 # end up with for (1 .. 0) { } which would effectivly skip the loop
291 my $lines = $buf =~ tr/\n//;
292 my $t_eof = $buf =~ s/^$TestWorker::EOF$//m;
297 my $result = $parser->next;
298 next unless defined($result);
299 if ($result->is_test) {
301 status($display, "$test: [$tests_completed/??] ");
302 } elsif ($result->is_bailout) {
303 Log status($display, "$test: BAILOUT");
304 status_completed(scalar @done);
306 say "test $test bailed out: " . $result->explanation;
311 return unless $t_eof;
313 Log status($display, "$test: finished");
314 $timings{$test} = time() - $timings{$test};
315 status_completed(scalar @done);
317 $aggregator->add($test, $parser);
318 push @done, [ $test, $output ];
321 take_job($worker, $cv, $tests);
327 $_->() for our @CLEANUP;
331 # must be in a begin block because we C<exit 0> above
334 require Carp; Carp::cluck("Caught SIG$_[0]\n");
336 } for qw(INT TERM QUIT KILL PIPE)
343 complete-run.pl - Run the i3 testsuite
347 complete-run.pl [files...]
351 To run the whole testsuite on a reasonable number of Xephyr instances (your
352 running X11 will not be touched), run:
355 To run only a specific test (useful when developing a new feature), run:
356 ./complete-run t/100-fullscreen.t
364 Specifies which X11 display should be used. Can be specified multiple times and
365 will parallelize the tests:
367 # Run tests on the second X server
368 ./complete-run.pl -d :1
370 # Run four tests in parallel on some Xephyr servers
371 ./complete-run.pl -d :1,:2,:3,:4
373 Note that it is not necessary to specify this anymore. If omitted,
374 complete-run.pl will start (num_cores * 2) Xephyr instances.
378 Runs i3 under valgrind to find memory problems. The output will be available in
379 C<latest/valgrind-for-$test.log>.
383 Runs i3 under strace to trace system calls. The output will be available in
384 C<latest/strace-for-$test.log>.
388 Runs i3 under xtrace to trace X11 requests/replies. The output will be
389 available in C<latest/xtrace-for-$test.log>.
391 =item B<--coverage-testing>
393 Exits i3 cleanly (instead of kill -9) to make coverage testing work properly.
397 Number of Xephyr instances to start (if you don’t want to start num_cores * 2
398 instances for some reason).
400 # Run all tests on a single Xephyr instance
401 ./complete-run.pl -p 1