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::Basename qw(basename);
12 use File::Temp qw(tempfile tempdir);
16 use Time::HiRes qw(sleep gettimeofday tv_interval);
19 use TAP::Parser::Aggregator;
20 # these are shipped with the testsuite
24 # the following modules are not shipped with Perl
28 use AnyEvent::I3 qw(:all);
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 # We actually use AnyEvent to make sure it loads an event loop implementation.
36 # Afterwards, we overwrite SIGCHLD:
37 my $cv = AnyEvent->condvar;
39 # Install a dummy CHLD handler to overwrite the CHLD handler of AnyEvent.
40 # AnyEvent’s handler wait()s for every child which conflicts with TAP (TAP
41 # needs to get the exit status to determine if a test is successful).
45 # convinience wrapper to write to the log file
47 sub Log { say $log "@_" }
49 my $coverage_testing = 0;
53 # Number of tests to run in parallel. Important to know how many Xdummy
54 # instances we need to start (unless @displays are given). Defaults to
59 my $result = GetOptions(
60 "coverage-testing" => \$coverage_testing,
61 "valgrind" => \$valgrind,
63 "display=s" => \@displays,
64 "parallel=i" => \$parallel,
68 pod2usage(-verbose => 2, -exitcode => 0) if $help;
70 @displays = split(/,/, join(',', @displays));
71 @displays = map { s/ //g; $_ } @displays;
73 # No displays specified, let’s start some Xdummy instances.
74 @displays = start_xdummy($parallel) if @displays == 0;
77 # connect to all displays for two reasons:
78 # 1: check if the display actually works
79 # 2: keep the connection open so that i3 is not the only client. this prevents
80 # the X server from exiting (Xdummy will restart it, but not quick enough
83 for my $display (@displays) {
85 my $x = X11::XCB->new($display, $screen);
87 die "Could not connect to display $display\n";
93 # 1: get a list of all testcases
94 my @testfiles = @ARGV;
96 # if no files were passed on command line, run all tests from t/
97 @testfiles = <t/*.t> if @testfiles == 0;
99 # 2: create an output directory for this test-run
100 my $outdir = "testsuite-";
101 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
102 $outdir .= `git describe --tags`;
104 mkdir($outdir) or die "Could not create $outdir";
105 unlink("latest") if -e "latest";
106 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
108 my $logfile = "$outdir/complete-run.log";
109 open $log, '>', $logfile or die "Could not create '$logfile': $!";
110 say "Writing logfile to '$logfile'...";
114 my $num = @testfiles;
115 my $harness = TAP::Harness->new({ });
117 my $aggregator = TAP::Parser::Aggregator->new();
118 $aggregator->start();
120 status_init(displays => \@displays, tests => $num);
122 # We start tests concurrently: For each display, one test gets started. Every
123 # test starts another test after completing.
124 for (@displays) { $cv->begin; take_job($_) }
130 # print empty lines to seperate failed tests from statuslines
134 my ($test, $output) = @$_;
135 Log "output for $test:";
137 # print error messages of failed tests
138 say for $output =~ /^not ok.+\n+((?:^#.+\n)+)/mg
142 $harness->summary($aggregator);
151 # Takes a test from the beginning of @testfiles and runs it.
153 # The TAP::Parser (which reads the test output) will get called as soon as
154 # there is some activity on the stdout file descriptor of the test process
155 # (using an AnyEvent->io watcher).
157 # When a test completes and @done contains $num entries, the $cv condvar gets
158 # triggered to finish testing.
163 my $test = shift @testfiles
166 my $basename = basename($test);
168 Log status($display, "Starting $test");
171 open(my $spool, '>', \$output);
172 my $parser = TAP::Parser->new({
173 exec => [ 'sh', '-c', qq|DISPLAY=$display TESTNAME="$basename" OUTDIR="$outdir" VALGRIND=$valgrind STRACE=$strace COVERAGE=$coverage_testing /usr/bin/perl -Ilib $test| ],
181 my ($stdout, $stderr) = $parser->get_select_handles;
182 for my $handle ($parser->get_select_handles) {
188 # Ignore activity on stderr (unnecessary with merge => 1,
189 # but let’s keep it in here if we want to use merge => 0
190 # for some reason in the future).
191 return if defined($stderr) and $handle == $stderr;
193 my $result = $parser->next;
194 if (defined($result)) {
196 status($display, "Running $test: [$tests_completed/??]");
197 # TODO: check if we should bail out
201 # $result is not defined, we are done parsing
202 Log status($display, "$test finished");
203 close($parser->delete_spool);
204 $aggregator->add($test, $parser);
205 push @done, [ $test, $output ];
207 status_completed(scalar @done);
209 undef $_ for @watchers;
222 $_->() for our @CLEANUP;
225 # must be in a begin block because we C<exit 0> above
226 BEGIN { $SIG{$_} = \&cleanup for qw(INT TERM QUIT KILL) }
232 complete-run.pl - Run the i3 testsuite
236 complete-run.pl [files...]
240 To run the whole testsuite on a reasonable number of Xdummy instances (your
241 running X11 will not be touched), run:
244 To run only a specific test (useful when developing a new feature), run:
245 ./complete-run t/100-fullscreen.t
253 Specifies which X11 display should be used. Can be specified multiple times and
254 will parallelize the tests:
256 # Run tests on the second X server
257 ./complete-run.pl -d :1
259 # Run four tests in parallel on some Xdummy servers
260 ./complete-run.pl -d :1,:2,:3,:4
262 Note that it is not necessary to specify this anymore. If omitted,
263 complete-run.pl will start (num_cores * 2) Xdummy instances.
267 Runs i3 under valgrind to find memory problems. The output will be available in
268 C<latest/valgrind-for-$test.log>.
272 Runs i3 under strace to trace system calls. The output will be available in
273 C<latest/strace-for-$test.log>.
275 =item B<--coverage-testing>
277 Exits i3 cleanly (instead of kill -9) to make coverage testing work properly.
281 Number of Xdummy instances to start (if you don’t want to start num_cores * 2
282 instances for some reason).
284 # Run all tests on a single Xdummy instance
285 ./complete-run.pl -p 1