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);
18 # these are shipped with the testsuite
23 # the following modules are not shipped with Perl
27 use AnyEvent::I3 qw(:all);
28 use X11::XCB::Connection;
29 use JSON::XS; # AnyEvent::I3 depends on it, too.
31 # Close superfluous file descriptors which were passed by running in a VIM
32 # subshell or situations like that.
33 AnyEvent::Util::close_all_fds_except(0, 1, 2);
35 # convinience wrapper to write to the log file
37 sub Log { say $log "@_" }
41 # Number of tests to run in parallel. Important to know how many Xdummy
42 # instances we need to start (unless @displays are given). Defaults to
53 my $result = GetOptions(
54 "coverage-testing" => \$options{coverage},
55 "valgrind" => \$options{valgrind},
56 "strace" => \$options{strace},
57 "display=s" => \@displays,
58 "parallel=i" => \$parallel,
62 pod2usage(-verbose => 2, -exitcode => 0) if $help;
64 @displays = split(/,/, join(',', @displays));
65 @displays = map { s/ //g; $_ } @displays;
67 # 2: get a list of all testcases
68 my @testfiles = @ARGV;
70 # if no files were passed on command line, run all tests from t/
71 @testfiles = <t/*.t> if @testfiles == 0;
73 my $numtests = scalar @testfiles;
75 # When the user specifies displays, we don’t run multi-monitor tests at all
76 # (because we don’t know which displaynumber is the X-Server with multiple
80 # No displays specified, let’s start some Xdummy instances.
83 ($dpyref, $multidpy) = start_xdummy($parallel, $numtests);
87 # 1: create an output directory for this test-run
88 my $outdir = "testsuite-";
89 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
90 $outdir .= `git describe --tags`;
92 mkdir($outdir) or die "Could not create $outdir";
93 unlink("latest") if -e "latest";
94 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
97 # connect to all displays for two reasons:
98 # 1: check if the display actually works
99 # 2: keep the connection open so that i3 is not the only client. this prevents
100 # the X server from exiting (Xdummy will restart it, but not quick enough
103 for my $display (@displays) {
105 my $x = X11::XCB::Connection->new(display => $display);
107 die "Could not connect to display $display\n";
109 # start a TestWorker for each display
110 push @single_worker, worker($display, $x, $outdir, \%options);
115 if (defined($multidpy)) {
116 my $x = X11::XCB::Connection->new(display => $multidpy);
118 die "Could not connect to multi-monitor display $multidpy\n";
120 push @multi_worker, worker($multidpy, $x, $outdir, \%options);
124 # Read previous timing information, if available. We will be able to roughly
125 # predict the test duration and schedule a good order for the tests.
126 my $timingsjson = StartXDummy::slurp('.last_run_timings.json');
127 %timings = %{decode_json($timingsjson)} if length($timingsjson) > 0;
129 # Re-order the files so that those which took the longest time in the previous
130 # run will be started at the beginning to not delay the whole run longer than
132 @testfiles = map { $_->[0] }
133 sort { $b->[1] <=> $a->[1] }
134 map { [$_, $timings{$_} // 999] } @testfiles;
136 printf("\nRough time estimate for this run: %.2f seconds\n\n", $timings{GLOBAL})
137 if exists($timings{GLOBAL});
139 # Forget the old timings, we don’t necessarily run the same set of tests as
140 # before. Otherwise we would end up with left-overs.
141 %timings = (GLOBAL => time());
143 my $logfile = "$outdir/complete-run.log";
144 open $log, '>', $logfile or die "Could not create '$logfile': $!";
145 say "Writing logfile to '$logfile'...";
149 my $num = @testfiles;
150 my $harness = TAP::Harness->new({ });
152 my @single_monitor_tests = grep { m,^t/([0-9]+)-, && $1 < 500 } @testfiles;
153 my @multi_monitor_tests = grep { m,^t/([0-9]+)-, && $1 >= 500 } @testfiles;
155 my $aggregator = TAP::Parser::Aggregator->new();
156 $aggregator->start();
158 status_init(displays => [ @displays, $multidpy ], tests => $num);
160 my $single_cv = AE::cv;
161 my $multi_cv = AE::cv;
163 # We start tests concurrently: For each display, one test gets started. Every
164 # test starts another test after completing.
165 for (@single_worker) {
167 take_job($_, $single_cv, \@single_monitor_tests);
169 for (@multi_worker) {
171 take_job($_, $multi_cv, \@multi_monitor_tests);
179 # print empty lines to seperate failed tests from statuslines
183 my ($test, $output) = @$_;
184 say "no output for $test" unless $output;
185 Log "output for $test:";
187 # print error messages of failed tests
188 say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
192 $harness->summary($aggregator);
196 # 5: Save the timings for better scheduling/prediction next run.
197 $timings{GLOBAL} = time() - $timings{GLOBAL};
198 open(my $fh, '>', '.last_run_timings.json');
199 print $fh encode_json(\%timings);
202 # 6: Print the slowest test files.
203 my @slowest = map { $_->[0] }
204 sort { $b->[1] <=> $a->[1] }
205 map { [$_, $timings{$_}] }
206 grep { !/^GLOBAL$/ } keys %timings;
208 say 'The slowest tests are:';
209 printf("\t%s with %.2f seconds\n", $_, $timings{$_})
210 for @slowest[0..($#slowest > 4 ? 4 : $#slowest)];
212 # When we are running precisely one test, print the output. Makes developing
213 # with a single testcase easier.
214 if ($numtests == 1) {
217 say StartXDummy::slurp($logfile);
225 # Takes a test from the beginning of @testfiles and runs it.
227 # The TAP::Parser (which reads the test output) will get called as soon as
228 # there is some activity on the stdout file descriptor of the test process
229 # (using an AnyEvent->io watcher).
231 # When a test completes and @done contains $num entries, the $cv condvar gets
232 # triggered to finish testing.
235 my ($worker, $cv, $tests) = @_;
237 my $test = shift @$tests
240 my $display = $worker->{display};
242 Log status($display, "$test: starting");
243 $timings{$test} = time();
244 worker_next($worker, $test);
246 # create a TAP::Parser with an in-memory fh
248 my $parser = TAP::Parser->new({
249 source => do { open(my $fh, '<', \$output); $fh },
252 my $ipc = $worker->{ipc};
259 state $tests_completed = 0;
262 sysread($ipc, my $buf, 4096) or die "sysread: $!";
265 $buf = $partial . $buf;
269 # make sure we feed TAP::Parser complete lines so it doesn't blow up
270 if (substr($buf, -1, 1) ne "\n") {
271 my $nl = rindex($buf, "\n");
277 # strip partial from buffer
278 $partial = substr($buf, $nl + 1, '');
281 # count lines before stripping eof-marker otherwise we might
282 # end up with for (1 .. 0) { } which would effectivly skip the loop
283 my $lines = $buf =~ tr/\n//;
284 my $t_eof = $buf =~ s/^$TestWorker::EOF$//m;
289 my $result = $parser->next;
290 if (defined($result) and $result->is_test) {
292 status($display, "$test: [$tests_completed/??] ");
296 return unless $t_eof;
298 Log status($display, "$test: finished");
299 $timings{$test} = time() - $timings{$test};
300 status_completed(scalar @done);
302 $aggregator->add($test, $parser);
303 push @done, [ $test, $output ];
306 take_job($worker, $cv, $tests);
312 $_->() for our @CLEANUP;
316 # must be in a begin block because we C<exit 0> above
319 require Carp; Carp::cluck("Caught SIG$_[0]\n");
321 } for qw(INT TERM QUIT KILL PIPE)
328 complete-run.pl - Run the i3 testsuite
332 complete-run.pl [files...]
336 To run the whole testsuite on a reasonable number of Xdummy instances (your
337 running X11 will not be touched), run:
340 To run only a specific test (useful when developing a new feature), run:
341 ./complete-run t/100-fullscreen.t
349 Specifies which X11 display should be used. Can be specified multiple times and
350 will parallelize the tests:
352 # Run tests on the second X server
353 ./complete-run.pl -d :1
355 # Run four tests in parallel on some Xdummy servers
356 ./complete-run.pl -d :1,:2,:3,:4
358 Note that it is not necessary to specify this anymore. If omitted,
359 complete-run.pl will start (num_cores * 2) Xdummy instances.
363 Runs i3 under valgrind to find memory problems. The output will be available in
364 C<latest/valgrind-for-$test.log>.
368 Runs i3 under strace to trace system calls. The output will be available in
369 C<latest/strace-for-$test.log>.
371 =item B<--coverage-testing>
373 Exits i3 cleanly (instead of kill -9) to make coverage testing work properly.
377 Number of Xdummy instances to start (if you don’t want to start num_cores * 2
378 instances for some reason).
380 # Run all tests on a single Xdummy instance
381 ./complete-run.pl -p 1