2 # vim:ts=4:sw=4:expandtab
3 use strict; use warnings;
5 use File::Temp qw(tmpnam tempfile tempdir);
11 use List::Util qw(first);
12 use Time::HiRes qw(sleep);
14 use Scalar::Util qw(blessed);
49 my $tester = Test::Builder->new();
50 my $_cached_socket_path = undef;
51 my $_sync_window = undef;
52 my $tmp_socket_path = undef;
59 return $window_count++;
68 # testcases which start i3 manually should always call exit_gracefully
69 # on their own. Let’s see, whether they really did.
70 if (! $i3_autostart) {
71 return unless $i3_pid;
73 $tester->ok(undef, 'testcase called exit_gracefully()');
76 # don't trigger SIGCHLD handler
79 # From perldoc -v '$?':
80 # Inside an "END" subroutine $? contains the value
81 # that is going to be given to "exit()".
83 # Since waitpid sets $?, we need to localize it,
84 # otherwise TAP would be misinterpreted our return status
87 # When measuring code coverage, try to exit i3 cleanly (otherwise, .gcda
88 # files are not written)
89 if ($ENV{COVERAGE} || $ENV{VALGRIND}) {
90 exit_gracefully($i3_pid, "/tmp/nested-$ENV{DISPLAY}");
94 or $tester->BAIL_OUT("could not kill i3");
101 my ($class, %args) = @_;
104 $i3_autostart = delete($args{i3_autostart}) // 1;
106 my $cv = launch_with_config('-default', dont_block => 1)
109 my $test_more_args = '';
110 $test_more_args = join(' ', 'qw(', %args, ')') if keys %args;
114 use Test::More $test_more_args;
117 use Time::HiRes qw(sleep);
119 $tester->BAIL_OUT("$@") if $@;
120 feature->import(":5.10");
124 $x ||= i3test::X11->new;
125 $cv->recv if $i3_autostart;
128 goto \&Exporter::import;
132 # Waits for the next event and calls the given callback for every event to
133 # determine if this is the event we are waiting for.
135 # Can be used to wait until a window is mapped, until a ClientMessage is
138 # wait_for_event $x, 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
141 my ($timeout, $cb) = @_;
147 # unfortunately, there is no constant for this
150 my $guard = AE::io $x->get_file_descriptor, $ae_read, sub {
151 while (defined(my $event = $x->poll_for_event)) {
159 # Trigger timeout after $timeout seconds (can be fractional)
160 my $t = AE::timer $timeout, 0, sub { warn "timeout ($timeout secs)"; $cv->send(0) };
162 my $result = $cv->recv;
168 # thin wrapper around wait_for_event which waits for MAP_NOTIFY
169 # make sure to include 'structure_notify' in the window’s event_mask attribute
172 my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
173 wait_for_event 2, sub {
174 $_[0]->{response_type} == MAP_NOTIFY and $_[0]->{window} == $id
178 # Wrapper around wait_for_event which waits for UNMAP_NOTIFY. Also calls
179 # sync_with_i3 to make sure i3 also picked up and processed the UnmapNotify
183 # my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
184 wait_for_event 2, sub {
185 $_[0]->{response_type} == UNMAP_NOTIFY # and $_[0]->{window} == $id
191 # Opens a new window (see X11::XCB::Window), maps it, waits until it got mapped
192 # and synchronizes with i3.
194 # set dont_map to a true value to avoid mapping
196 # if you want to change aspects of your window before it would be mapped,
197 # set before_map to a coderef. $window gets passed as $_ and as first argument.
199 # if you set both dont_map and before_map, the coderef will be called nevertheless
203 # class => WINDOW_CLASS_INPUT_OUTPUT
204 # rect => [ 0, 0, 30, 30 ]
205 # background_color => '#c0c0c0'
206 # event_mask => [ 'structure_notify' ]
207 # name => 'Window <n>'
210 my %args = @_ == 1 ? %{$_[0]} : @_;
212 my $dont_map = delete $args{dont_map};
213 my $before_map = delete $args{before_map};
215 $args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
216 $args{rect} //= [ 0, 0, 30, 30 ];
217 $args{background_color} //= '#c0c0c0';
218 $args{event_mask} //= [ 'structure_notify' ];
219 $args{name} //= 'Window ' . counter_window();
221 my $window = $x->root->create_child(%args);
224 # TODO: investigate why _create is not needed
226 $before_map->($window) for $window;
229 return $window if $dont_map;
232 wait_for_map($window);
236 # Thin wrapper around open_window which sets window_type to
237 # _NET_WM_WINDOW_TYPE_UTILITY to make the window floating.
238 sub open_floating_window {
239 my %args = @_ == 1 ? %{$_[0]} : @_;
241 $args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
243 return open_window(\%args);
249 my $reply = $i3->command('open')->recv;
250 return $reply->[0]->{id};
253 sub get_workspace_names {
254 my $i3 = i3(get_socket_path());
255 my $tree = $i3->get_tree->recv;
256 my @outputs = @{$tree->{nodes}};
258 for my $output (@outputs) {
259 next if $output->{name} eq '__i3';
260 # get the first CT_CON of each output
261 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
262 @cons = (@cons, @{$content->{nodes}});
264 [ map { $_->{name} } @cons ]
267 sub get_unused_workspace {
268 my @names = get_workspace_names();
270 do { $tmp = tmpnam() } while ($tmp ~~ @names);
274 =head2 fresh_workspace(...)
276 Switches to an unused workspace and returns the name of that workspace.
278 Optionally switches to the specified output first.
280 my $ws = fresh_workspace;
282 # Get a fresh workspace on the second output.
283 my $ws = fresh_workspace(output => 1);
286 sub fresh_workspace {
288 if (exists($args{output})) {
289 my $i3 = i3(get_socket_path());
290 my $tree = $i3->get_tree->recv;
291 my $output = first { $_->{name} eq "fake-$args{output}" }
293 die "BUG: Could not find output $args{output}" unless defined($output);
294 # Get the focused workspace on that output and switch to it.
295 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
296 my $focused = $content->{focus}->[0];
297 my $workspace = first { $_->{id} == $focused } @{$content->{nodes}};
298 $workspace = $workspace->{name};
299 cmd("workspace $workspace");
302 my $unused = get_unused_workspace;
303 cmd("workspace $unused");
309 my $i3 = i3(get_socket_path());
310 my $tree = $i3->get_tree->recv;
312 my @outputs = @{$tree->{nodes}};
314 for my $output (@outputs) {
315 # get the first CT_CON of each output
316 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
317 @workspaces = (@workspaces, @{$content->{nodes}});
320 # as there can only be one workspace with this name, we can safely
321 # return the first entry
322 return first { $_->{name} eq $name } @workspaces;
326 # returns the content (== tree, starting from the node of a workspace)
327 # of a workspace. If called in array context, also includes the focus
328 # stack of the workspace
332 my $con = get_ws($name);
333 return wantarray ? ($con->{nodes}, $con->{focus}) : $con->{nodes};
338 my $con = get_ws($ws);
340 my @focused = @{$con->{focus}};
342 while (@focused > 0) {
344 last unless defined($con->{focus});
345 @focused = @{$con->{focus}};
346 my @cons = grep { $_->{id} == $lf } (@{$con->{nodes}}, @{$con->{'floating_nodes'}});
353 sub get_dock_clients {
356 my $tree = i3(get_socket_path())->get_tree->recv;
357 my @outputs = @{$tree->{nodes}};
358 # Children of all dockareas
360 for my $output (@outputs) {
361 if (!defined($which)) {
362 @docked = (@docked, map { @{$_->{nodes}} }
363 grep { $_->{type} == 5 }
364 @{$output->{nodes}});
365 } elsif ($which eq 'top') {
366 my $first = first { $_->{type} == 5 } @{$output->{nodes}};
367 @docked = (@docked, @{$first->{nodes}}) if defined($first);
368 } elsif ($which eq 'bottom') {
369 my @matching = grep { $_->{type} == 5 } @{$output->{nodes}};
370 my $last = $matching[-1];
371 @docked = (@docked, @{$last->{nodes}}) if defined($last);
378 i3(get_socket_path())->command(@_)->recv
381 sub workspace_exists {
383 ($name ~~ @{get_workspace_names()})
388 Returns the name of the currently focused workspace.
392 my $i3 = i3(get_socket_path());
393 my $tree = $i3->get_tree->recv;
394 my $focused = $tree->{focus}->[0];
395 my $output = first { $_->{id} == $focused } @{$tree->{nodes}};
396 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
397 my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
398 return $first->{name}
402 # Sends an I3_SYNC ClientMessage with a random value to the root window.
403 # i3 will reply with the same value, but, due to the order of events it
404 # processes, only after all other events are done.
406 # This can be used to ensure the results of a cmd 'focus left' are pushed to
407 # X11 and that $x->input_focus returns the correct value afterwards.
409 # See also docs/testsuite for a long explanation
412 my %args = @_ == 1 ? %{$_[0]} : @_;
414 # Since we need a (mapped) window for receiving a ClientMessage, we create
415 # one on the first call of sync_with_i3. It will be re-used in all
417 if (!exists($args{window_id}) &&
418 (!defined($_sync_window) || exists($args{no_cache}))) {
419 $_sync_window = open_window(
420 rect => [ -15, -15, 10, 10 ],
421 override_redirect => 1,
425 my $window_id = delete $args{window_id};
426 $window_id //= $_sync_window->id;
428 my $root = $x->get_root_window();
429 # Generate a random number to identify this particular ClientMessage.
430 my $myrnd = int(rand(255)) + 1;
432 # Generate a ClientMessage, see xcb_client_message_t
433 my $msg = pack "CCSLLLLLLL",
434 CLIENT_MESSAGE, # response_type
437 $root, # destination window
438 $x->atom(name => 'I3_SYNC')->id,
440 $window_id, # data[0]: our own window id
441 $myrnd, # data[1]: a random value to identify the request
446 # Send it to the root window -- since i3 uses the SubstructureRedirect
447 # event mask, it will get the ClientMessage.
448 $x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
450 # now wait until the reply is here
451 return wait_for_event 2, sub {
454 return 0 unless $event->{response_type} == 161;
456 my ($win, $rnd) = unpack "LL", $event->{data};
457 return ($rnd == $myrnd);
462 my $tree = i3(get_socket_path())->get_tree->recv;
463 my @nodes = @{$tree->{nodes}};
464 my $ok = (@nodes > 0);
465 $tester->ok($ok, 'i3 still lives');
469 # Tries to exit i3 gracefully (with the 'exit' cmd) or kills the PID if that fails
470 sub exit_gracefully {
471 my ($pid, $socketpath) = @_;
472 $socketpath ||= get_socket_path();
476 say "Exiting i3 cleanly...";
477 i3($socketpath)->command('exit')->recv;
483 or $tester->BAIL_OUT("could not kill i3");
486 if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
494 # Gets the socket path from the I3_SOCKET_PATH atom stored on the X11 root window
495 sub get_socket_path {
499 if ($cache && defined($_cached_socket_path)) {
500 return $_cached_socket_path;
503 my $atom = $x->atom(name => 'I3_SOCKET_PATH');
504 my $cookie = $x->get_property(0, $x->get_root_window(), $atom->id, GET_PROPERTY_TYPE_ANY, 0, 256);
505 my $reply = $x->get_property_reply($cookie->{sequence});
506 my $socketpath = $reply->{value};
507 if ($socketpath eq "/tmp/nested-$ENV{DISPLAY}") {
508 $socketpath .= '-activation';
510 $_cached_socket_path = $socketpath;
515 # launches a new i3 process with the given string as configuration file.
516 # useful for tests which test specific config file directives.
517 sub launch_with_config {
518 my ($config, %args) = @_;
520 $tmp_socket_path = "/tmp/nested-$ENV{DISPLAY}";
522 $args{dont_create_temp_dir} //= 0;
524 my ($fh, $tmpfile) = tempfile("i3-cfg-for-$ENV{TESTNAME}-XXXXX", UNLINK => 1);
526 if ($config ne '-default') {
529 open(my $conf_fh, '<', './i3-test.config')
530 or $tester->BAIL_OUT("could not open default config: $!");
532 say $fh scalar <$conf_fh>;
535 say $fh "ipc-socket $tmp_socket_path"
536 unless $args{dont_add_socket_path};
540 my $cv = AnyEvent->condvar;
541 $i3_pid = activate_i3(
542 unix_socket_path => "$tmp_socket_path-activation",
543 display => $ENV{DISPLAY},
544 configfile => $tmpfile,
545 outdir => $ENV{OUTDIR},
546 testname => $ENV{TESTNAME},
547 valgrind => $ENV{VALGRIND},
548 strace => $ENV{STRACE},
549 restart => $ENV{RESTART},
551 dont_create_temp_dir => $args{dont_create_temp_dir},
554 # force update of the cached socket path in lib/i3test
555 # as soon as i3 has started
556 $cv->cb(sub { get_socket_path(0) });
558 return $cv if $args{dont_block};
560 # blockingly wait until i3 is ready
567 use parent 'X11::XCB::Connection';
571 i3test::sync_with_i3();
573 return $self->SUPER::input_focus(@_);