2 # vim:ts=4:sw=4:expandtab
3 # © 2010 Michael Stapelberg and contributors
9 # the following are modules which ship with Perl (>= 5.10):
11 use File::Temp qw(tempfile tempdir);
16 use TAP::Parser::Aggregator;
17 use Time::HiRes qw(time);
20 # these are shipped with the testsuite
21 use lib qw(@abs_top_builddir@/testcases/lib @abs_top_srcdir@/testcases/lib);
22 use i3test::Util qw(slurp);
26 # the following modules are not shipped with Perl
30 use AnyEvent::I3 qw(:all);
31 use X11::XCB::Connection;
32 use JSON::XS; # AnyEvent::I3 depends on it, too.
34 binmode STDOUT, ':utf8';
35 binmode STDERR, ':utf8';
37 # Close superfluous file descriptors which were passed by running in a VIM
38 # subshell or situations like that.
39 AnyEvent::Util::close_all_fds_except(0, 1, 2);
41 # convenience wrapper to write to the log file
43 sub Log { say $log "@_" }
47 # Number of tests to run in parallel. Important to know how many Xephyr
48 # instances we need to start (unless @displays are given). Defaults to
59 my $keep_xserver_output = 0;
61 my $result = GetOptions(
62 "coverage-testing" => \$options{coverage},
63 "keep-xserver-output" => \$keep_xserver_output,
64 "valgrind" => \$options{valgrind},
65 "strace" => \$options{strace},
66 "xtrace" => \$options{xtrace},
67 "display=s" => \@displays,
68 "parallel=i" => \$parallel,
72 pod2usage(-verbose => 2, -exitcode => 0) if $help;
74 # Check for missing executables
77 @abs_top_builddir@/i3bar/i3bar
78 @abs_top_builddir@/i3-config-wizard/i3-config-wizard
79 @abs_top_builddir@/i3-dump-log/i3-dump-log
80 @abs_top_builddir@/i3-input/i3-input
81 @abs_top_builddir@/i3-msg/i3-msg
82 @abs_top_builddir@/i3-nagbar/i3-nagbar
85 foreach my $binary (@binaries) {
86 die "$binary executable not found, did you run “make”?" unless -e $binary;
87 die "$binary is not an executable" unless -x $binary;
90 $ENV{PATH} = join(':',
91 '@abs_top_builddir@/i3-nagbar',
92 '@abs_top_builddir@/i3-msg',
93 '@abs_top_builddir@/i3-input',
94 '@abs_top_builddir@/i3-dump-log',
95 '@abs_top_builddir@/i3-config-wizard',
96 '@abs_top_builddir@/i3bar',
101 qx(Xephyr -help 2>&1);
102 die "Xephyr was not found in your path. Please install Xephyr (xserver-xephyr on Debian)." if $?;
104 @displays = split(/,/, join(',', @displays));
105 @displays = map { s/ //g; $_ } @displays;
107 # 2: get a list of all testcases
108 my @testfiles = @ARGV;
110 # if no files were passed on command line, run all tests from t/
111 if (scalar @testfiles == 0) {
112 @testfiles = <@abs_top_srcdir@/testcases/t/*.t> if @testfiles == 0;
115 # Fully qualify each specified file if necessary
117 $_ = "@abs_top_srcdir@/testcases/$_";
123 my $numtests = scalar @testfiles;
125 # No displays specified, let’s start some Xephyr instances.
126 if (@displays == 0) {
127 @displays = start_xserver($parallel, $numtests, $keep_xserver_output);
130 # 1: create an output directory for this test-run
131 my $outdir = "testsuite-";
132 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
133 $outdir .= `git describe --tags`;
135 mkdir($outdir) or die "Could not create $outdir";
136 unlink("latest") if -l "latest";
137 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
140 # connect to all displays for two reasons:
141 # 1: check if the display actually works
142 # 2: keep the connection open so that i3 is not the only client. this prevents
143 # the X server from exiting
145 for my $display (@displays) {
147 my $x = X11::XCB::Connection->new(display => $display);
149 die "Could not connect to display $display\n";
151 # start a TestWorker for each display
152 push @single_worker, worker($display, $x, $outdir, \%options);
156 # Read previous timing information, if available. We will be able to roughly
157 # predict the test duration and schedule a good order for the tests.
158 my $timingsjson = slurp('.last_run_timings.json') if -e '.last_run_timings.json';
159 %timings = %{decode_json($timingsjson)} if length($timingsjson) > 0;
161 # Re-order the files so that those which took the longest time in the previous
162 # run will be started at the beginning to not delay the whole run longer than
164 @testfiles = map { $_->[0] }
165 sort { $b->[1] <=> $a->[1] }
166 map { [$_, $timings{$_} // 999] } @testfiles;
168 # Run 000-load-deps.t first to bail out early when dependencies are missing.
169 my $loadtest = "t/000-load-deps.t";
170 if ((scalar grep { $_ eq $loadtest } @testfiles) > 0) {
171 @testfiles = ($loadtest, grep { $_ ne $loadtest } @testfiles);
174 printf("\nRough time estimate for this run: %.2f seconds\n\n", $timings{GLOBAL})
175 if exists($timings{GLOBAL});
177 # Forget the old timings, we don’t necessarily run the same set of tests as
178 # before. Otherwise we would end up with left-overs.
179 %timings = (GLOBAL => time());
181 my $logfile = "$outdir/complete-run.log";
182 open $log, '>', $logfile or die "Could not create '$logfile': $!";
184 say "Writing logfile to '$logfile'...";
188 my $num = @testfiles;
189 my $harness = TAP::Harness->new({ });
191 my $aggregator = TAP::Parser::Aggregator->new();
192 $aggregator->start();
194 status_init(displays => \@displays, tests => $num);
196 my $single_cv = AE::cv;
198 # We start tests concurrently: For each display, one test gets started. Every
199 # test starts another test after completing.
200 for (@single_worker) {
202 take_job($_, $single_cv, \@testfiles);
209 # print empty lines to separate failed tests from statuslines
213 my ($test, $output) = @$_;
214 say "no output for $test" unless $output;
215 Log "output for $test:";
217 # print error messages of failed tests
218 say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
222 $harness->summary($aggregator);
226 # 5: Save the timings for better scheduling/prediction next run.
227 $timings{GLOBAL} = time() - $timings{GLOBAL};
228 open(my $fh, '>', '.last_run_timings.json');
229 print $fh encode_json(\%timings);
232 # 6: Print the slowest test files.
233 my @slowest = map { $_->[0] }
234 sort { $b->[1] <=> $a->[1] }
235 map { [$_, $timings{$_}] }
236 grep { !/^GLOBAL$/ } keys %timings;
238 say 'The slowest tests are:';
239 printf("\t%s with %.2f seconds\n", $_, $timings{$_})
240 for @slowest[0..($#slowest > 4 ? 4 : $#slowest)];
242 # When we are running precisely one test, print the output. Makes developing
243 # with a single testcase easier.
244 if ($numtests == 1) {
252 # Report logfiles that match “(Leak|Address)Sanitizer:”.
254 for my $log (<$outdir/i3-log-for-*>) {
255 if (slurp($log) =~ /(Leak|Address)Sanitizer:/) {
256 push @logs_with_leaks, $log;
259 if (scalar @logs_with_leaks > 0) {
260 say "\nThe following test logfiles contain AddressSanitizer or LeakSanitizer reports:";
261 for my $log (sort @logs_with_leaks) {
266 exit ($aggregator->failed > 0);
269 # Takes a test from the beginning of @testfiles and runs it.
271 # The TAP::Parser (which reads the test output) will get called as soon as
272 # there is some activity on the stdout file descriptor of the test process
273 # (using an AnyEvent->io watcher).
275 # When a test completes and @done contains $num entries, the $cv condvar gets
276 # triggered to finish testing.
279 my ($worker, $cv, $tests) = @_;
281 my $test = shift @$tests
284 my $display = $worker->{display};
286 Log status($display, "$test: starting");
287 $timings{$test} = time();
288 worker_next($worker, $test);
290 # create a TAP::Parser with an in-memory fh
292 my $parser = TAP::Parser->new({
293 source => do { open(my $fh, '<', \$output); $fh },
296 my $ipc = $worker->{ipc};
303 state $tests_completed = 0;
306 sysread($ipc, my $buf, 4096) or die "sysread: $!";
309 $buf = $partial . $buf;
313 # make sure we feed TAP::Parser complete lines so it doesn't blow up
314 if (substr($buf, -1, 1) ne "\n") {
315 my $nl = rindex($buf, "\n");
321 # strip partial from buffer
322 $partial = substr($buf, $nl + 1, '');
325 # count lines before stripping eof-marker otherwise we might
326 # end up with for (1 .. 0) { } which would effectivly skip the loop
327 my $lines = $buf =~ tr/\n//;
328 my $t_eof = $buf =~ s/^$TestWorker::EOF$//m;
333 my $result = $parser->next;
334 next unless defined($result);
335 if ($result->is_test) {
337 status($display, "$test: [$tests_completed/??] ");
338 } elsif ($result->is_bailout) {
339 Log status($display, "$test: BAILOUT");
340 status_completed(scalar @done);
342 say "test $test bailed out: " . $result->explanation;
347 return unless $t_eof;
349 Log status($display, "$test: finished");
350 $timings{$test} = time() - $timings{$test};
351 status_completed(scalar @done);
353 $aggregator->add($test, $parser);
354 push @done, [ $test, $output ];
357 take_job($worker, $cv, $tests);
364 $_->() for our @CLEANUP;
368 # must be in a begin block because we C<exit 0> above
371 require Carp; Carp::cluck("Caught SIG$_[0]\n");
373 } for qw(INT TERM QUIT KILL PIPE)
380 complete-run.pl - Run the i3 testsuite
384 complete-run.pl [files...]
388 To run the whole testsuite on a reasonable number of Xephyr instances (your
389 running X11 will not be touched), run:
392 To run only a specific test (useful when developing a new feature), run:
393 ./complete-run t/100-fullscreen.t
401 Specifies which X11 display should be used. Can be specified multiple times and
402 will parallelize the tests:
404 # Run tests on the second X server
405 ./complete-run.pl -d :1
407 # Run four tests in parallel on some Xephyr servers
408 ./complete-run.pl -d :1,:2,:3,:4
410 Note that it is not necessary to specify this anymore. If omitted,
411 complete-run.pl will start (num_cores * 2) Xephyr instances.
415 Runs i3 under valgrind to find memory problems. The output will be available in
416 C<latest/valgrind-for-$test.log>.
420 Runs i3 under strace to trace system calls. The output will be available in
421 C<latest/strace-for-$test.log>.
425 Runs i3 under xtrace to trace X11 requests/replies. The output will be
426 available in C<latest/xtrace-for-$test.log>.
428 =item B<--coverage-testing>
430 Generates a test coverage report at C<latest/i3-coverage>. Exits i3 cleanly
431 during tests (instead of kill -9) to make coverage testing work properly.
435 Number of Xephyr instances to start (if you don't want to start num_cores * 2
436 instances for some reason).
438 # Run all tests on a single Xephyr instance
439 ./complete-run.pl -p 1