2 # vim:ts=4:sw=4:expandtab
3 use strict; use warnings;
5 use File::Temp qw(tmpnam tempfile tempdir);
12 use List::Util qw(first);
13 use Time::HiRes qw(sleep);
45 my $tester = Test::Builder->new();
46 my $_cached_socket_path = undef;
47 my $_sync_window = undef;
48 my $tmp_socket_path = undef;
55 return $window_count++;
63 my $test_most_args = @_ ? "qw(@_)" : "";
67 use Test::Most $test_most_args;
70 use Time::HiRes qw(sleep);
71 use Test::Deep qw(eq_deeply cmp_deeply);
73 $tester->bail_out("$@") if $@;
74 feature->import(":5.10");
78 $x ||= i3test::X11->new;
80 goto \&Exporter::import;
84 # Waits for the next event and calls the given callback for every event to
85 # determine if this is the event we are waiting for.
87 # Can be used to wait until a window is mapped, until a ClientMessage is
90 # wait_for_event $x, 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
93 my ($timeout, $cb) = @_;
97 my $prep = EV::prepare sub {
101 my $check = EV::check sub {
102 while (defined(my $event = $x->poll_for_event)) {
110 my $watcher = EV::io $x->get_file_descriptor, EV::READ, sub {
111 # do nothing, we only need this watcher so that EV picks up the events
114 # Trigger timeout after $timeout seconds (can be fractional)
115 my $t = AE::timer $timeout, 0, sub { warn "timeout ($timeout secs)"; $cv->send(0) };
117 my $result = $cv->recv;
122 # thin wrapper around wait_for_event which waits for MAP_NOTIFY
123 # make sure to include 'structure_notify' in the window’s event_mask attribute
125 wait_for_event 2, sub { $_[0]->{response_type} == MAP_NOTIFY };
128 # Wrapper around wait_for_event which waits for UNMAP_NOTIFY. Also calls
129 # sync_with_i3 to make sure i3 also picked up and processed the UnmapNotify
132 wait_for_event 2, sub { $_[0]->{response_type} == UNMAP_NOTIFY };
137 # Opens a new window (see X11::XCB::Window), maps it, waits until it got mapped
138 # and synchronizes with i3.
140 # set dont_map to a true value to avoid mapping
143 # class => WINDOW_CLASS_INPUT_OUTPUT
144 # rect => [ 0, 0, 30, 30 ]
145 # background_color => '#c0c0c0'
146 # event_mask => [ 'structure_notify' ]
147 # name => 'Window <n>'
151 my %args = ($args ? %$args : ());
153 my $dont_map = delete $args{dont_map};
155 $args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
156 $args{rect} //= [ 0, 0, 30, 30 ];
157 $args{background_color} //= '#c0c0c0';
158 $args{event_mask} //= [ 'structure_notify' ];
159 $args{name} //= 'Window ' . counter_window();
161 my $window = $x->root->create_child(%args);
163 return $window if $dont_map;
167 # We sync with i3 here to make sure $x->input_focus is updated.
172 # Thin wrapper around open_window which sets window_type to
173 # _NET_WM_WINDOW_TYPE_UTILITY to make the window floating.
174 sub open_floating_window {
176 my %args = ($args ? %$args : ());
178 $args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
180 return open_window($x, \%args);
186 my $reply = $i3->command('open')->recv;
190 sub get_workspace_names {
191 my $i3 = i3(get_socket_path());
192 my $tree = $i3->get_tree->recv;
193 my @outputs = @{$tree->{nodes}};
195 for my $output (@outputs) {
196 # get the first CT_CON of each output
197 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
198 @cons = (@cons, @{$content->{nodes}});
200 [ map { $_->{name} } @cons ]
203 sub get_unused_workspace {
204 my @names = get_workspace_names();
206 do { $tmp = tmpnam() } while ($tmp ~~ @names);
210 sub fresh_workspace {
211 my $unused = get_unused_workspace;
212 cmd("workspace $unused");
218 my $i3 = i3(get_socket_path());
219 my $tree = $i3->get_tree->recv;
221 my @outputs = @{$tree->{nodes}};
223 for my $output (@outputs) {
224 # get the first CT_CON of each output
225 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
226 @workspaces = (@workspaces, @{$content->{nodes}});
229 # as there can only be one workspace with this name, we can safely
230 # return the first entry
231 return first { $_->{name} eq $name } @workspaces;
235 # returns the content (== tree, starting from the node of a workspace)
236 # of a workspace. If called in array context, also includes the focus
237 # stack of the workspace
241 my $con = get_ws($name);
242 return wantarray ? ($con->{nodes}, $con->{focus}) : $con->{nodes};
247 my $con = get_ws($ws);
249 my @focused = @{$con->{focus}};
251 while (@focused > 0) {
253 last unless defined($con->{focus});
254 @focused = @{$con->{focus}};
255 my @cons = grep { $_->{id} == $lf } (@{$con->{nodes}}, @{$con->{'floating_nodes'}});
262 sub get_dock_clients {
265 my $tree = i3(get_socket_path())->get_tree->recv;
266 my @outputs = @{$tree->{nodes}};
267 # Children of all dockareas
269 for my $output (@outputs) {
270 if (!defined($which)) {
271 @docked = (@docked, map { @{$_->{nodes}} }
272 grep { $_->{type} == 5 }
273 @{$output->{nodes}});
274 } elsif ($which eq 'top') {
275 my $first = first { $_->{type} == 5 } @{$output->{nodes}};
276 @docked = (@docked, @{$first->{nodes}});
277 } elsif ($which eq 'bottom') {
278 my @matching = grep { $_->{type} == 5 } @{$output->{nodes}};
279 my $last = $matching[-1];
280 @docked = (@docked, @{$last->{nodes}});
287 i3(get_socket_path())->command(@_)->recv
290 sub workspace_exists {
292 ($name ~~ @{get_workspace_names()})
296 my $i3 = i3(get_socket_path());
297 my $tree = $i3->get_tree->recv;
298 my @outputs = @{$tree->{nodes}};
300 for my $output (@outputs) {
301 # get the first CT_CON of each output
302 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
303 my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
304 return $first->{name}
309 # Sends an I3_SYNC ClientMessage with a random value to the root window.
310 # i3 will reply with the same value, but, due to the order of events it
311 # processes, only after all other events are done.
313 # This can be used to ensure the results of a cmd 'focus left' are pushed to
314 # X11 and that $x->input_focus returns the correct value afterwards.
316 # See also docs/testsuite for a long explanation
321 # Since we need a (mapped) window for receiving a ClientMessage, we create
322 # one on the first call of sync_with_i3. It will be re-used in all
324 if (!defined($_sync_window)) {
325 $_sync_window = $x->root->create_child(
326 class => WINDOW_CLASS_INPUT_OUTPUT,
327 rect => X11::XCB::Rect->new(x => -15, y => -15, width => 10, height => 10 ),
328 override_redirect => 1,
329 background_color => '#ff0000',
330 event_mask => [ 'structure_notify' ],
335 wait_for_event 2, sub { $_[0]->{response_type} == MAP_NOTIFY };
338 my $root = $x->get_root_window();
339 # Generate a random number to identify this particular ClientMessage.
340 my $myrnd = int(rand(255)) + 1;
342 # Generate a ClientMessage, see xcb_client_message_t
343 my $msg = pack "CCSLLLLLLL",
344 CLIENT_MESSAGE, # response_type
347 $root, # destination window
348 $x->atom(name => 'I3_SYNC')->id,
350 $_sync_window->id, # data[0]: our own window id
351 $myrnd, # data[1]: a random value to identify the request
356 # Send it to the root window -- since i3 uses the SubstructureRedirect
357 # event mask, it will get the ClientMessage.
358 $x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
360 # now wait until the reply is here
361 return wait_for_event 2, sub {
364 return 0 unless $event->{response_type} == 161;
366 my ($win, $rnd) = unpack "LL", $event->{data};
367 return ($rnd == $myrnd);
372 my $tree = i3(get_socket_path())->get_tree->recv;
373 my @nodes = @{$tree->{nodes}};
374 my $ok = (@nodes > 0);
375 $tester->ok($ok, 'i3 still lives');
379 # Tries to exit i3 gracefully (with the 'exit' cmd) or kills the PID if that fails
380 sub exit_gracefully {
381 my ($pid, $socketpath) = @_;
382 $socketpath ||= get_socket_path();
386 say "Exiting i3 cleanly...";
387 i3($socketpath)->command('exit')->recv;
392 kill(9, $pid) or die "could not kill i3";
395 if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
400 # Gets the socket path from the I3_SOCKET_PATH atom stored on the X11 root window
401 sub get_socket_path {
405 if ($cache && defined($_cached_socket_path)) {
406 return $_cached_socket_path;
409 my $atom = $x->atom(name => 'I3_SOCKET_PATH');
410 my $cookie = $x->get_property(0, $x->get_root_window(), $atom->id, GET_PROPERTY_TYPE_ANY, 0, 256);
411 my $reply = $x->get_property_reply($cookie->{sequence});
412 my $socketpath = $reply->{value};
413 $_cached_socket_path = $socketpath;
418 # launches a new i3 process with the given string as configuration file.
419 # useful for tests which test specific config file directives.
421 # be sure to use !NO_I3_INSTANCE! somewhere in the file to signal
422 # complete-run.pl that it should not create an instance of i3
424 sub launch_with_config {
425 my ($config, $dont_add_socket_path) = @_;
427 $dont_add_socket_path //= 0;
429 if (!defined($tmp_socket_path)) {
430 $tmp_socket_path = File::Temp::tempnam('/tmp', 'i3-test-socket-');
433 my ($fh, $tmpfile) = tempfile('/tmp/i3-test-config-XXXXX', UNLINK => 1);
435 say $fh "ipc-socket $tmp_socket_path" unless $dont_add_socket_path;
438 my $cv = AnyEvent->condvar;
439 my $pid = activate_i3(
440 unix_socket_path => "$tmp_socket_path-activation",
441 display => $ENV{DISPLAY},
442 configfile => $tmpfile,
443 outdir => $ENV{OUTDIR},
444 testname => $ENV{TESTNAME},
445 valgrind => $ENV{VALGRIND},
446 strace => $ENV{STRACE},
450 # blockingly wait until i3 is ready
453 # force update of the cached socket path in lib/i3test
460 use parent 'X11::XCB::Connection';
464 i3test::sync_with_i3($self);
466 return $self->SUPER::input_focus(@_);