2 # vim:ts=4:sw=4:expandtab
3 # © 2010-2011 Michael Stapelberg and contributors
8 # 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);
19 # these are shipped with the testsuite
24 # the following modules are not shipped with Perl
28 use AnyEvent::I3 qw(:all);
29 use X11::XCB::Connection;
30 use JSON::XS; # AnyEvent::I3 depends on it, too.
32 # Close superfluous file descriptors which were passed by running in a VIM
33 # subshell or situations like that.
34 AnyEvent::Util::close_all_fds_except(0, 1, 2);
36 # convinience wrapper to write to the log file
38 sub Log { say $log "@_" }
42 # Number of tests to run in parallel. Important to know how many Xdummy
43 # instances we need to start (unless @displays are given). Defaults to
55 my $result = GetOptions(
56 "coverage-testing" => \$options{coverage},
57 "valgrind" => \$options{valgrind},
58 "strace" => \$options{strace},
59 "xtrace" => \$options{xtrace},
60 "display=s" => \@displays,
61 "parallel=i" => \$parallel,
65 pod2usage(-verbose => 2, -exitcode => 0) if $help;
67 @displays = split(/,/, join(',', @displays));
68 @displays = map { s/ //g; $_ } @displays;
70 # 2: get a list of all testcases
71 my @testfiles = @ARGV;
73 # if no files were passed on command line, run all tests from t/
74 @testfiles = <t/*.t> if @testfiles == 0;
76 my $numtests = scalar @testfiles;
78 # No displays specified, let’s start some Xdummy instances.
80 @displays = start_xdummy($parallel, $numtests);
83 # 1: create an output directory for this test-run
84 my $outdir = "testsuite-";
85 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
86 $outdir .= `git describe --tags`;
88 mkdir($outdir) or die "Could not create $outdir";
89 unlink("latest") if -e "latest";
90 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
93 # connect to all displays for two reasons:
94 # 1: check if the display actually works
95 # 2: keep the connection open so that i3 is not the only client. this prevents
96 # the X server from exiting (Xdummy will restart it, but not quick enough
99 for my $display (@displays) {
101 my $x = X11::XCB::Connection->new(display => $display);
103 die "Could not connect to display $display\n";
105 # start a TestWorker for each display
106 push @single_worker, worker($display, $x, $outdir, \%options);
110 # Read previous timing information, if available. We will be able to roughly
111 # predict the test duration and schedule a good order for the tests.
112 my $timingsjson = StartXDummy::slurp('.last_run_timings.json');
113 %timings = %{decode_json($timingsjson)} if length($timingsjson) > 0;
115 # Re-order the files so that those which took the longest time in the previous
116 # run will be started at the beginning to not delay the whole run longer than
118 @testfiles = map { $_->[0] }
119 sort { $b->[1] <=> $a->[1] }
120 map { [$_, $timings{$_} // 999] } @testfiles;
122 printf("\nRough time estimate for this run: %.2f seconds\n\n", $timings{GLOBAL})
123 if exists($timings{GLOBAL});
125 # Forget the old timings, we don’t necessarily run the same set of tests as
126 # before. Otherwise we would end up with left-overs.
127 %timings = (GLOBAL => time());
129 my $logfile = "$outdir/complete-run.log";
130 open $log, '>', $logfile or die "Could not create '$logfile': $!";
132 say "Writing logfile to '$logfile'...";
136 my $num = @testfiles;
137 my $harness = TAP::Harness->new({ });
139 my $aggregator = TAP::Parser::Aggregator->new();
140 $aggregator->start();
142 status_init(displays => \@displays, tests => $num);
144 my $single_cv = AE::cv;
146 # We start tests concurrently: For each display, one test gets started. Every
147 # test starts another test after completing.
148 for (@single_worker) {
150 take_job($_, $single_cv, \@testfiles);
157 # print empty lines to seperate failed tests from statuslines
161 my ($test, $output) = @$_;
162 say "no output for $test" unless $output;
163 Log "output for $test:";
165 # print error messages of failed tests
166 say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
170 $harness->summary($aggregator);
174 # 5: Save the timings for better scheduling/prediction next run.
175 $timings{GLOBAL} = time() - $timings{GLOBAL};
176 open(my $fh, '>', '.last_run_timings.json');
177 print $fh encode_json(\%timings);
180 # 6: Print the slowest test files.
181 my @slowest = map { $_->[0] }
182 sort { $b->[1] <=> $a->[1] }
183 map { [$_, $timings{$_}] }
184 grep { !/^GLOBAL$/ } keys %timings;
186 say 'The slowest tests are:';
187 printf("\t%s with %.2f seconds\n", $_, $timings{$_})
188 for @slowest[0..($#slowest > 4 ? 4 : $#slowest)];
190 # When we are running precisely one test, print the output. Makes developing
191 # with a single testcase easier.
192 if ($numtests == 1) {
195 say StartXDummy::slurp($logfile);
203 # Takes a test from the beginning of @testfiles and runs it.
205 # The TAP::Parser (which reads the test output) will get called as soon as
206 # there is some activity on the stdout file descriptor of the test process
207 # (using an AnyEvent->io watcher).
209 # When a test completes and @done contains $num entries, the $cv condvar gets
210 # triggered to finish testing.
213 my ($worker, $cv, $tests) = @_;
215 my $test = shift @$tests
218 my $display = $worker->{display};
220 Log status($display, "$test: starting");
221 $timings{$test} = time();
222 worker_next($worker, $test);
224 # create a TAP::Parser with an in-memory fh
226 my $parser = TAP::Parser->new({
227 source => do { open(my $fh, '<', \$output); $fh },
230 my $ipc = $worker->{ipc};
237 state $tests_completed = 0;
240 sysread($ipc, my $buf, 4096) or die "sysread: $!";
243 $buf = $partial . $buf;
247 # make sure we feed TAP::Parser complete lines so it doesn't blow up
248 if (substr($buf, -1, 1) ne "\n") {
249 my $nl = rindex($buf, "\n");
255 # strip partial from buffer
256 $partial = substr($buf, $nl + 1, '');
259 # count lines before stripping eof-marker otherwise we might
260 # end up with for (1 .. 0) { } which would effectivly skip the loop
261 my $lines = $buf =~ tr/\n//;
262 my $t_eof = $buf =~ s/^$TestWorker::EOF$//m;
267 my $result = $parser->next;
268 if (defined($result) and $result->is_test) {
270 status($display, "$test: [$tests_completed/??] ");
274 return unless $t_eof;
276 Log status($display, "$test: finished");
277 $timings{$test} = time() - $timings{$test};
278 status_completed(scalar @done);
280 $aggregator->add($test, $parser);
281 push @done, [ $test, $output ];
284 take_job($worker, $cv, $tests);
290 $_->() for our @CLEANUP;
294 # must be in a begin block because we C<exit 0> above
297 require Carp; Carp::cluck("Caught SIG$_[0]\n");
299 } for qw(INT TERM QUIT KILL PIPE)
306 complete-run.pl - Run the i3 testsuite
310 complete-run.pl [files...]
314 To run the whole testsuite on a reasonable number of Xdummy instances (your
315 running X11 will not be touched), run:
318 To run only a specific test (useful when developing a new feature), run:
319 ./complete-run t/100-fullscreen.t
327 Specifies which X11 display should be used. Can be specified multiple times and
328 will parallelize the tests:
330 # Run tests on the second X server
331 ./complete-run.pl -d :1
333 # Run four tests in parallel on some Xdummy servers
334 ./complete-run.pl -d :1,:2,:3,:4
336 Note that it is not necessary to specify this anymore. If omitted,
337 complete-run.pl will start (num_cores * 2) Xdummy instances.
341 Runs i3 under valgrind to find memory problems. The output will be available in
342 C<latest/valgrind-for-$test.log>.
346 Runs i3 under strace to trace system calls. The output will be available in
347 C<latest/strace-for-$test.log>.
351 Runs i3 under xtrace to trace X11 requests/replies. The output will be
352 available in C<latest/xtrace-for-$test.log>.
354 =item B<--coverage-testing>
356 Exits i3 cleanly (instead of kill -9) to make coverage testing work properly.
360 Number of Xdummy instances to start (if you don’t want to start num_cores * 2
361 instances for some reason).
363 # Run all tests on a single Xdummy instance
364 ./complete-run.pl -p 1