]> git.sur5r.net Git - i3/i3/blob - testcases/complete-run.pl
db797bd20a6e52ed9ee8939e1ffdee2c792337b0
[i3/i3] / testcases / complete-run.pl
1 #!/usr/bin/env perl
2 # vim:ts=4:sw=4:expandtab
3 #
4 # © 2010-2011 Michael Stapelberg and contributors
5 #
6 # syntax: ./complete-run.pl --display :1 --display :2
7 # to run the test suite on the X11 displays :1 and :2
8 # use 'Xdummy :1' and 'Xdummy :2' before to start two
9 # headless X11 servers
10 #
11
12 use strict;
13 use warnings;
14 use v5.10;
15 # the following are modules which ship with Perl (>= 5.10):
16 use Cwd qw(abs_path);
17 use File::Basename qw(basename);
18 use File::Temp qw(tempfile tempdir);
19 use Getopt::Long;
20 use IO::Socket::UNIX;
21 use POSIX;
22 use Time::HiRes qw(sleep gettimeofday tv_interval);
23 use TAP::Harness;
24 use TAP::Parser;
25 use TAP::Parser::Aggregator;
26 # these are shipped with the testsuite
27 use lib qw(lib);
28 use SocketActivation;
29 # the following modules are not shipped with Perl
30 use EV;
31 use AnyEvent;
32 use AnyEvent::Handle;
33 use AnyEvent::I3 qw(:all);
34 use Try::Tiny; # not in core
35 use X11::XCB;
36
37 # install a dummy CHLD handler to overwrite the CHLD handler of AnyEvent / EV
38 # XXX: we could maybe also use a different loop than the default loop in EV?
39 $SIG{CHLD} = sub {
40 };
41
42 # reads in a whole file
43 sub slurp {
44     open my $fh, '<', shift;
45     local $/;
46     <$fh>;
47 }
48
49 my $coverage_testing = 0;
50 my @displays = ();
51
52 my $result = GetOptions(
53     "coverage-testing" => \$coverage_testing,
54     "display=s" => \@displays,
55 );
56
57 @displays = split(/,/, join(',', @displays));
58 @displays = map { s/ //g; $_ } @displays;
59
60 @displays = qw(:1) if @displays == 0;
61
62 # connect to all displays for two reasons:
63 # 1: check if the display actually works
64 # 2: keep the connection open so that i3 is not the only client. this prevents
65 #    the X server from exiting (Xdummy will restart it, but not quick enough
66 #    sometimes)
67 my @conns;
68 my @wdisplays;
69 for my $display (@displays) {
70     my $screen;
71     my $x = X11::XCB->new($display, $screen);
72     if ($x->has_error) {
73         say STDERR "WARNING: Not using X11 display $display, could not connect";
74     } else {
75         push @conns, $x;
76         push @wdisplays, $display;
77     }
78 }
79
80 my $config = slurp('i3-test.config');
81
82 # 1: get a list of all testcases
83 my @testfiles = @ARGV;
84
85 # if no files were passed on command line, run all tests from t/
86 @testfiles = <t/*.t> if @testfiles == 0;
87
88 # 2: create an output directory for this test-run
89 my $outdir = "testsuite-";
90 $outdir .= POSIX::strftime("%Y-%m-%d-%H-%M-%S-", localtime());
91 $outdir .= `git describe --tags`;
92 chomp($outdir);
93 mkdir($outdir) or die "Could not create $outdir";
94 unlink("latest") if -e "latest";
95 symlink("$outdir", "latest") or die "Could not symlink latest to $outdir";
96
97 # 3: run all tests
98 my @done;
99 my $num = @testfiles;
100 my $harness = TAP::Harness->new({ });
101
102 my $aggregator = TAP::Parser::Aggregator->new();
103 $aggregator->start();
104
105 my $cv = AnyEvent->condvar;
106
107 # We start tests concurrently: For each display, one test gets started. Every
108 # test starts another test after completing.
109 take_job($_) for @wdisplays;
110
111 #
112 # Takes a test from the beginning of @testfiles and runs it.
113 #
114 # The TAP::Parser (which reads the test output) will get called as soon as
115 # there is some activity on the stdout file descriptor of the test process
116 # (using an AnyEvent->io watcher).
117 #
118 # When a test completes and @done contains $num entries, the $cv condvar gets
119 # triggered to finish testing.
120 #
121 sub take_job {
122     my ($display) = @_;
123
124     my $test = shift @testfiles;
125     return unless $test;
126     my $dont_start = (slurp($test) =~ /# !NO_I3_INSTANCE!/);
127     my $logpath = "$outdir/i3-log-for-" . basename($test);
128
129     my ($fh, $tmpfile) = tempfile('i3-run-cfg.XXXXXX', UNLINK => 1);
130     say $fh $config;
131     say $fh "ipc-socket /tmp/nested-$display";
132     close($fh);
133
134     my $activate_cv = AnyEvent->condvar;
135     my $time_before_start = [gettimeofday];
136
137     my $pid;
138     if (!$dont_start) {
139         $pid = activate_i3(
140             unix_socket_path => "/tmp/nested-$display-activation",
141             display => $display,
142             configfile => $tmpfile,
143             logpath => $logpath,
144             cv => $activate_cv
145         );
146
147         my $child_watcher;
148         $child_watcher = AnyEvent->child(pid => $pid, cb => sub {
149             say "child died. pid = $pid";
150             undef $child_watcher;
151         });
152     }
153
154     my $kill_i3 = sub {
155         # Don’t bother killing i3 when we haven’t started it
156         return if $dont_start;
157
158         # When measuring code coverage, try to exit i3 cleanly (otherwise, .gcda
159         # files are not written) and fallback to killing it
160         if ($coverage_testing) {
161             my $exited = 0;
162             try {
163                 say "Exiting i3 cleanly...";
164                 i3("/tmp/nested-$display")->command('exit')->recv;
165                 $exited = 1;
166             };
167             return if $exited;
168         }
169
170         say "[$display] killing i3";
171         kill(9, $pid) or die "could not kill i3";
172     };
173
174     # This will be called as soon as i3 is running and answered to our
175     # IPC request
176     $activate_cv->cb(sub {
177         my $time_activating = [gettimeofday];
178         my $start_duration = tv_interval($time_before_start, $time_activating);
179         my ($status) = $activate_cv->recv;
180         if ($dont_start) {
181             say "[$display] Not starting i3, testcase does that";
182         } else {
183             say "[$display] i3 startup: took " . sprintf("%.2f", $start_duration) . "s, status = $status";
184         }
185
186         say "[$display] Running $test with logfile $logpath";
187
188         my $output;
189         open(my $spool, '>', \$output);
190         my $parser = TAP::Parser->new({
191             exec => [ 'sh', '-c', qq|DISPLAY=$display LOGPATH="$logpath" /usr/bin/perl -Ilib $test| ],
192             spool => $spool,
193             merge => 1,
194         });
195
196         my @watchers;
197         my ($stdout, $stderr) = $parser->get_select_handles;
198         for my $handle ($parser->get_select_handles) {
199             my $w;
200             $w = AnyEvent->io(
201                 fh => $handle,
202                 poll => 'r',
203                 cb => sub {
204                     # Ignore activity on stderr (unnecessary with merge => 1,
205                     # but let’s keep it in here if we want to use merge => 0
206                     # for some reason in the future).
207                     return if defined($stderr) and $handle == $stderr;
208
209                     my $result = $parser->next;
210                     if (defined($result)) {
211                         # TODO: check if we should bail out
212                         return;
213                     }
214
215                     # $result is not defined, we are done parsing
216                     say "[$display] $test finished";
217                     close($parser->delete_spool);
218                     $aggregator->add($test, $parser);
219                     push @done, [ $test, $output ];
220
221                     $kill_i3->();
222
223                     undef $_ for @watchers;
224                     if (@done == $num) {
225                         $cv->send;
226                     } else {
227                         take_job($display);
228                     }
229                 }
230             );
231             push @watchers, $w;
232         }
233     });
234
235     $activate_cv->send(1) if $dont_start;
236 }
237
238 $cv->recv;
239
240 $aggregator->stop();
241
242 for (@done) {
243     my ($test, $output) = @$_;
244     say "output for $test:";
245     say $output;
246 }
247
248 # 4: print summary
249 $harness->summary($aggregator);