2 # vim:ts=4:sw=4:expandtab
3 use strict; use warnings;
5 use File::Temp qw(tmpnam tempfile tempdir);
10 use lib qw(@abs_top_srcdir@/AnyEvent-I3/blib/lib);
12 use List::Util qw(first);
13 use Time::HiRes qw(sleep);
15 use Scalar::Util qw(blessed);
17 use i3test::Util qw(slurp);
56 i3test - Testcase setup module
64 my $ws = fresh_workspace;
65 is_num_children($ws, 0, 'no containers on this workspace yet');
67 is_num_children($ws, 1, 'one container after "open"');
73 This module is used in every i3 testcase and takes care of automatically
74 starting i3 before any test instructions run. It also saves you typing of lots
75 of boilerplate in every test file.
78 i3test automatically "use"s C<Test::More>, C<Data::Dumper>, C<AnyEvent::I3>,
79 C<Time::HiRes>’s C<sleep> and C<i3test::Test> so that all of them are available
80 to you in your testcase.
82 See also C<i3test::Test> (L<https://build.i3wm.org/docs/lib-i3test-test.html>)
83 which provides additional test instructions (like C<ok> or C<is>).
87 my $tester = Test::Builder->new();
88 my $_cached_socket_path = undef;
89 my $_sync_window = undef;
90 my $tmp_socket_path = undef;
97 return $window_count++;
105 # Skip the remaining cleanup for testcases which set i3_autostart => 0:
106 return if !defined($i3_pid) && !$i3_autostart;
108 # don't trigger SIGCHLD handler
111 # From perldoc -v '$?':
112 # Inside an "END" subroutine $? contains the value
113 # that is going to be given to "exit()".
115 # Since waitpid sets $?, we need to localize it,
116 # otherwise TAP would be misinterpreted our return status
119 # When measuring code coverage, try to exit i3 cleanly (otherwise, .gcda
120 # files are not written)
121 if ($ENV{COVERAGE} || $ENV{VALGRIND}) {
122 exit_gracefully($i3_pid, "/tmp/nested-$ENV{DISPLAY}");
126 or $tester->BAIL_OUT("could not kill i3");
133 my ($class, %args) = @_;
136 $i3_autostart = delete($args{i3_autostart}) // 1;
137 my $i3_config = delete($args{i3_config}) // '-default';
139 my $cv = launch_with_config($i3_config, dont_block => 1)
142 my $test_more_args = '';
143 $test_more_args = join(' ', 'qw(', %args, ')') if keys %args;
147 use Test::More $test_more_args;
150 use Time::HiRes qw(sleep);
153 $tester->BAIL_OUT("$@") if $@;
154 feature->import(":5.10");
158 $x ||= i3test::X11->new;
159 # set the pointer to a predictable position in case a previous test has
161 $x->root->warp_pointer(0, 0);
162 $cv->recv if $i3_autostart;
165 goto \&Exporter::import;
170 =head2 wait_for_event($timeout, $callback)
172 Waits for the next event and calls the given callback for every event to
173 determine if this is the event we are waiting for.
175 Can be used to wait until a window is mapped, until a ClientMessage is
178 wait_for_event 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
182 my ($timeout, $cb) = @_;
188 # unfortunately, there is no constant for this
191 my $guard = AE::io $x->get_file_descriptor, $ae_read, sub {
192 while (defined(my $event = $x->poll_for_event)) {
200 # Trigger timeout after $timeout seconds (can be fractional)
201 my $t = AE::timer $timeout, 0, sub { warn "timeout ($timeout secs)"; $cv->send(0) };
203 my $result = $cv->recv;
209 =head2 wait_for_map($window)
211 Thin wrapper around wait_for_event which waits for MAP_NOTIFY.
212 Make sure to include 'structure_notify' in the window’s event_mask attribute.
214 This function is called by C<open_window>, so in most cases, you don’t need to
215 call it on your own. If you need special setup of the window before mapping,
216 you might have to map it on your own and use this function:
218 my $window = open_window(dont_map => 1);
219 # Do something special with the window first
222 # Now map it and wait until it’s been mapped
224 wait_for_map($window);
229 my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
230 wait_for_event 4, sub {
231 $_[0]->{response_type} == MAP_NOTIFY and $_[0]->{window} == $id
235 =head2 wait_for_unmap($window)
237 Wrapper around C<wait_for_event> which waits for UNMAP_NOTIFY. Also calls
238 C<sync_with_i3> to make sure i3 also picked up and processed the UnmapNotify
241 my $ws = fresh_workspace;
242 my $window = open_window;
243 is_num_children($ws, 1, 'one window on workspace');
246 is_num_children($ws, 0, 'no more windows on this workspace');
251 # my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
252 wait_for_event 4, sub {
253 $_[0]->{response_type} == UNMAP_NOTIFY # and $_[0]->{window} == $id
258 =head2 open_window([ $args ])
260 Opens a new window (see C<X11::XCB::Window>), maps it, waits until it got mapped
261 and synchronizes with i3.
263 The following arguments can be passed:
269 The X11 window class (e.g. WINDOW_CLASS_INPUT_OUTPUT), not to be confused with
274 An arrayref with 4 members specifying the initial geometry (position and size)
275 of the window, e.g. C<< [ 0, 100, 70, 50 ] >> for a window appearing at x=0, y=100
276 with width=70 and height=50.
278 Note that this is entirely irrelevant for tiling windows.
280 =item background_color
282 The background pixel color of the window, formatted as "#rrggbb", like HTML
283 color codes (e.g. #c0c0c0). This is useful to tell windows apart when actually
284 watching the testcases.
288 An arrayref containing strings which describe the X11 event mask we use for that
289 window. The default is C<< [ 'structure_notify' ] >>.
293 The window’s C<_NET_WM_NAME> (UTF-8 window title). By default, this is "Window
294 n" with n being replaced by a counter to keep windows apart.
298 Set to a true value to avoid mapping the window (making it visible).
302 A coderef which is called before the window is mapped (unless C<dont_map> is
303 true). The freshly created C<$window> is passed as C<$_> and as the first
308 The default values are equivalent to this call:
311 class => WINDOW_CLASS_INPUT_OUTPUT
312 rect => [ 0, 0, 30, 30 ]
313 background_color => '#c0c0c0'
314 event_mask => [ 'structure_notify' ]
318 Usually, though, calls are simpler:
320 my $top_window = open_window;
322 To identify the resulting window object in i3 commands, use the id property:
324 my $top_window = open_window;
325 cmd '[id="' . $top_window->id . '"] kill';
329 my %args = @_ == 1 ? %{$_[0]} : @_;
331 my $dont_map = delete $args{dont_map};
332 my $before_map = delete $args{before_map};
334 $args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
335 $args{rect} //= [ 0, 0, 30, 30 ];
336 $args{background_color} //= '#c0c0c0';
337 $args{event_mask} //= [ 'structure_notify' ];
338 $args{name} //= 'Window ' . counter_window();
340 my $window = $x->root->create_child(%args);
341 $window->add_hint('input');
344 # TODO: investigate why _create is not needed
346 $before_map->($window) for $window;
349 return $window if $dont_map;
352 wait_for_map($window);
356 =head2 open_floating_window([ $args ])
358 Thin wrapper around open_window which sets window_type to
359 C<_NET_WM_WINDOW_TYPE_UTILITY> to make the window floating.
361 The arguments are the same as those of C<open_window>.
364 sub open_floating_window {
365 my %args = @_ == 1 ? %{$_[0]} : @_;
367 $args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
369 return open_window(\%args);
375 my $reply = $i3->command('open')->recv;
376 return $reply->[0]->{id};
379 =head2 get_workspace_names()
381 Returns an arrayref containing the name of every workspace (regardless of its
382 output) which currently exists.
384 my $workspace_names = get_workspace_names;
385 is(scalar @$workspace_names, 3, 'three workspaces exist currently');
388 sub get_workspace_names {
389 my $i3 = i3(get_socket_path());
390 my $tree = $i3->get_tree->recv;
391 my @outputs = @{$tree->{nodes}};
393 for my $output (@outputs) {
394 next if $output->{name} eq '__i3';
395 # get the first CT_CON of each output
396 my $content = first { $_->{type} eq 'con' } @{$output->{nodes}};
397 @cons = (@cons, @{$content->{nodes}});
399 [ map { $_->{name} } @cons ]
402 =head2 get_unused_workspace
404 Returns a workspace name which has not yet been used. See also
405 C<fresh_workspace> which directly switches to an unused workspace.
407 my $ws = get_unused_workspace;
411 sub get_unused_workspace {
412 my @names = get_workspace_names();
414 do { $tmp = tmpnam() } while ((scalar grep { $_ eq $tmp } @names) > 0);
418 =head2 fresh_workspace([ $args ])
420 Switches to an unused workspace and returns the name of that workspace.
422 Optionally switches to the specified output first.
424 my $ws = fresh_workspace;
426 # Get a fresh workspace on the second output.
427 my $ws = fresh_workspace(output => 1);
430 sub fresh_workspace {
432 if (exists($args{output})) {
433 my $i3 = i3(get_socket_path());
434 my $tree = $i3->get_tree->recv;
435 my $output = first { $_->{name} eq "fake-$args{output}" }
437 die "BUG: Could not find output $args{output}" unless defined($output);
438 # Get the focused workspace on that output and switch to it.
439 my $content = first { $_->{type} eq 'con' } @{$output->{nodes}};
440 my $focused = $content->{focus}->[0];
441 my $workspace = first { $_->{id} == $focused } @{$content->{nodes}};
442 $workspace = $workspace->{name};
443 cmd("workspace $workspace");
446 my $unused = get_unused_workspace;
447 cmd("workspace $unused");
451 =head2 get_ws($workspace)
453 Returns the container (from the i3 layout tree) which represents C<$workspace>.
455 my $ws = fresh_workspace;
456 my $ws_con = get_ws($ws);
457 ok(!$ws_con->{urgent}, 'fresh workspace not marked urgent');
459 Here is an example which counts the number of urgent containers recursively,
460 starting from the workspace container:
465 my @children = (@{$con->{nodes}}, @{$con->{floating_nodes}});
466 my $urgent = grep { $_->{urgent} } @children;
467 $urgent += count_urgent($_) for @children;
470 my $urgent = count_urgent(get_ws($ws));
471 is($urgent, 3, "three urgent windows on workspace $ws");
477 my $i3 = i3(get_socket_path());
478 my $tree = $i3->get_tree->recv;
480 my @outputs = @{$tree->{nodes}};
482 for my $output (@outputs) {
483 # get the first CT_CON of each output
484 my $content = first { $_->{type} eq 'con' } @{$output->{nodes}};
485 @workspaces = (@workspaces, @{$content->{nodes}});
488 # as there can only be one workspace with this name, we can safely
489 # return the first entry
490 return first { $_->{name} eq $name } @workspaces;
493 =head2 get_ws_content($workspace)
495 Returns the content (== tree, starting from the node of a workspace)
496 of a workspace. If called in array context, also includes the focus
497 stack of the workspace.
499 my $nodes = get_ws_content($ws);
500 is(scalar @$nodes, 4, 'there are four containers at workspace-level');
502 Or, in array context:
504 my $window = open_window;
505 my ($nodes, $focus) = get_ws_content($ws);
506 is($focus->[0], $window->id, 'newly opened window focused');
508 Note that this function does not do recursion for you! It only returns the
509 containers B<on workspace level>. If you want to work with all containers (even
510 nested ones) on a workspace, you have to use recursion:
512 # NB: This function does not count floating windows
517 for my $con (@$nodes) {
518 $urgent++ if $con->{urgent};
519 $urgent += count_urgent($con->{nodes});
524 my $nodes = get_ws_content($ws);
525 my $urgent = count_urgent($nodes);
526 is($urgent, 3, "three urgent windows on workspace $ws");
528 If you also want to deal with floating windows, you have to use C<get_ws>
529 instead and access C<< ->{nodes} >> and C<< ->{floating_nodes} >> on your own.
534 my $con = get_ws($name);
535 return wantarray ? ($con->{nodes}, $con->{focus}) : $con->{nodes};
538 =head2 get_focused($workspace)
540 Returns the container ID of the currently focused container on C<$workspace>.
542 Note that the container ID is B<not> the X11 window ID, so comparing the result
543 of C<get_focused> with a window's C<< ->{id} >> property does B<not> work.
545 my $ws = fresh_workspace;
546 my $first_window = open_window;
547 my $first_id = get_focused();
549 my $second_window = open_window;
550 my $second_id = get_focused();
554 is(get_focused($ws), $first_id, 'second window focused');
559 my $con = get_ws($ws);
561 my @focused = @{$con->{focus}};
563 while (@focused > 0) {
565 last unless defined($con->{focus});
566 @focused = @{$con->{focus}};
567 my @cons = grep { $_->{id} == $lf } (@{$con->{nodes}}, @{$con->{'floating_nodes'}});
574 =head2 get_dock_clients([ $dockarea ])
576 Returns an array of all dock containers in C<$dockarea> (one of "top" or
577 "bottom"). If C<$dockarea> is not specified, returns an array of all dock
578 containers in any dockarea.
580 my @docked = get_dock_clients;
581 is(scalar @docked, 0, 'no dock clients yet');
584 sub get_dock_clients {
587 my $tree = i3(get_socket_path())->get_tree->recv;
588 my @outputs = @{$tree->{nodes}};
589 # Children of all dockareas
591 for my $output (@outputs) {
592 if (!defined($which)) {
593 @docked = (@docked, map { @{$_->{nodes}} }
594 grep { $_->{type} eq 'dockarea' }
595 @{$output->{nodes}});
596 } elsif ($which eq 'top') {
597 my $first = first { $_->{type} eq 'dockarea' } @{$output->{nodes}};
598 @docked = (@docked, @{$first->{nodes}}) if defined($first);
599 } elsif ($which eq 'bottom') {
600 my @matching = grep { $_->{type} eq 'dockarea' } @{$output->{nodes}};
601 my $last = $matching[-1];
602 @docked = (@docked, @{$last->{nodes}}) if defined($last);
610 Sends the specified command to i3 and returns the output.
612 my $ws = unused_workspace;
618 i3(get_socket_path())->command(@_)->recv
621 =head2 workspace_exists($workspace)
623 Returns true if C<$workspace> is the name of an existing workspace.
625 my $old_ws = focused_ws;
626 # switch away from where we currently are
629 ok(workspace_exists($old_ws), 'old workspace still exists');
632 sub workspace_exists {
634 (scalar grep { $_ eq $name } @{get_workspace_names()}) > 0;
639 Returns the name of the currently focused workspace.
642 is($ws, '1', 'i3 starts on workspace 1');
646 my $i3 = i3(get_socket_path());
647 my $tree = $i3->get_tree->recv;
648 my $focused = $tree->{focus}->[0];
649 my $output = first { $_->{id} == $focused } @{$tree->{nodes}};
650 my $content = first { $_->{type} eq 'con' } @{$output->{nodes}};
651 my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
652 return $first->{name}
655 =head2 sync_with_i3([ $args ])
657 Sends an I3_SYNC ClientMessage with a random value to the root window.
658 i3 will reply with the same value, but, due to the order of events it
659 processes, only after all other events are done.
661 This can be used to ensure the results of a cmd 'focus left' are pushed to
662 X11 and that C<< $x->input_focus >> returns the correct value afterwards.
664 See also L<https://build.i3wm.org/docs/testsuite.html> for a longer explanation.
666 my $window = open_window;
667 $window->add_hint('urgency');
668 # Ensure i3 picked up the change
671 The only time when you need to use the C<no_cache> argument is when you just
672 killed your own X11 connection:
675 # We need to re-establish the X11 connection which we just killed :).
676 $x = i3test::X11->new;
677 sync_with_i3(no_cache => 1);
681 my %args = @_ == 1 ? %{$_[0]} : @_;
683 # Since we need a (mapped) window for receiving a ClientMessage, we create
684 # one on the first call of sync_with_i3. It will be re-used in all
686 if (!exists($args{window_id}) &&
687 (!defined($_sync_window) || exists($args{no_cache}))) {
688 $_sync_window = open_window(
689 rect => [ -15, -15, 10, 10 ],
690 override_redirect => 1,
694 my $window_id = delete $args{window_id};
695 $window_id //= $_sync_window->id;
697 my $root = $x->get_root_window();
698 # Generate a random number to identify this particular ClientMessage.
699 my $myrnd = int(rand(255)) + 1;
701 # Generate a ClientMessage, see xcb_client_message_t
702 my $msg = pack "CCSLLLLLLL",
703 CLIENT_MESSAGE, # response_type
706 $root, # destination window
707 $x->atom(name => 'I3_SYNC')->id,
709 $window_id, # data[0]: our own window id
710 $myrnd, # data[1]: a random value to identify the request
715 # Send it to the root window -- since i3 uses the SubstructureRedirect
716 # event mask, it will get the ClientMessage.
717 $x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
719 return $myrnd if $args{dont_wait_for_event};
721 # now wait until the reply is here
722 return wait_for_event 4, sub {
725 return 0 unless $event->{response_type} == 161;
727 my ($win, $rnd) = unpack "LL", $event->{data};
728 return ($rnd == $myrnd);
732 =head2 exit_gracefully($pid, [ $socketpath ])
734 Tries to exit i3 gracefully (with the 'exit' cmd) or kills the PID if that fails.
736 If C<$socketpath> is not specified, C<get_socket_path()> will be called.
738 You only need to use this function if you have launched i3 on your own with
739 C<launch_with_config>. Otherwise, it will be automatically called when the
742 use i3test i3_autostart => 0;
743 my $pid = launch_with_config($config);
745 exit_gracefully($pid);
748 sub exit_gracefully {
749 my ($pid, $socketpath) = @_;
750 $socketpath ||= get_socket_path();
754 say "Exiting i3 cleanly...";
755 i3($socketpath)->command('exit')->recv;
761 or $tester->BAIL_OUT("could not kill i3");
764 if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
772 =head2 get_socket_path([ $cache ])
774 Gets the socket path from the C<I3_SOCKET_PATH> atom stored on the X11 root
775 window. After the first call, this function will return a cached version of the
776 socket path unless you specify a false value for C<$cache>.
778 my $i3 = i3(get_socket_path());
779 $i3->command('nop test example')->recv;
783 my $i3 = i3(get_socket_path(0));
786 sub get_socket_path {
790 if ($cache && defined($_cached_socket_path)) {
791 return $_cached_socket_path;
793 my $socketpath = i3test::Util::get_socket_path($x);
794 $_cached_socket_path = $socketpath;
798 =head2 launch_with_config($config, [ $args ])
800 Launches a new i3 process with C<$config> as configuration file. Useful for
801 tests which test specific config file directives.
803 use i3test i3_autostart => 0;
806 # i3 config file (v4)
807 for_window [class="borderless"] border none
808 for_window [title="special borderless title"] border none
811 my $pid = launch_with_config($config);
815 exit_gracefully($pid);
818 sub launch_with_config {
819 my ($config, %args) = @_;
821 $tmp_socket_path = "/tmp/nested-$ENV{DISPLAY}";
823 $args{dont_create_temp_dir} //= 0;
824 $args{validate_config} //= 0;
826 my ($fh, $tmpfile) = tempfile("i3-cfg-for-$ENV{TESTNAME}-XXXXX", UNLINK => 1);
828 say $fh "ipc-socket $tmp_socket_path"
829 unless $args{dont_add_socket_path};
831 if ($config ne '-default') {
834 open(my $conf_fh, '<', '@abs_top_srcdir@/testcases/i3-test.config')
835 or $tester->BAIL_OUT("could not open default config: $!");
837 say $fh scalar <$conf_fh>;
842 my $cv = AnyEvent->condvar;
843 $i3_pid = activate_i3(
844 unix_socket_path => "$tmp_socket_path-activation",
845 display => $ENV{DISPLAY},
846 configfile => $tmpfile,
847 outdir => $ENV{OUTDIR},
848 testname => $ENV{TESTNAME},
849 valgrind => $ENV{VALGRIND},
850 strace => $ENV{STRACE},
851 xtrace => $ENV{XTRACE},
852 restart => $ENV{RESTART},
854 dont_create_temp_dir => $args{dont_create_temp_dir},
855 validate_config => $args{validate_config},
856 inject_randr15 => $args{inject_randr15},
857 inject_randr15_outputinfo => $args{inject_randr15_outputinfo},
860 # If we called i3 with -C, we wait for it to exit and then return as
861 # there's nothing else we need to do.
862 if ($args{validate_config}) {
866 # We need this since exit_gracefully will not be called in this case.
869 return ${^CHILD_ERROR_NATIVE};
872 # force update of the cached socket path in lib/i3test
873 # as soon as i3 has started
874 $cv->cb(sub { get_socket_path(0) });
876 return $cv if $args{dont_block};
878 # blockingly wait until i3 is ready
886 Returns the content of the log file for the current test.
890 my $logfile = "$ENV{OUTDIR}/i3-log-for-$ENV{TESTNAME}";
891 return slurp($logfile);
894 =head2 kill_all_windows
896 Kills all windows to clean up between tests.
899 sub kill_all_windows {
900 # Sync in case not all windows are managed by i3 just yet.
902 cmd '[title=".*"] kill';
905 =head2 events_for($subscribecb, [ $rettype ], [ $eventcbs ])
907 Helper function which returns an array containing all events of type $rettype
908 which were generated by i3 while $subscribecb was running.
910 Set $eventcbs to subscribe to multiple event types and/or perform your own event
915 my ($subscribecb, $rettype, $eventcbs) = @_;
919 if (defined($rettype)) {
920 $eventcbs->{$rettype} = sub { push @events, shift };
922 my $subscribed = AnyEvent->condvar;
923 my $flushed = AnyEvent->condvar;
924 $eventcbs->{tick} = sub {
926 if ($event->{first}) {
927 $subscribed->send($event);
929 $flushed->send($event);
932 my $i3 = i3(get_socket_path(0));
934 $i3->subscribe($eventcbs)->recv;
936 # Subscription established, run the callback.
938 # Now generate a tick event, which we know we’ll receive (and at which point
939 # all other events have been received).
940 my $nonce = int(rand(255)) + 1;
941 $i3->send_tick($nonce);
943 my $tick = $flushed->recv;
944 $tester->is_eq($tick->{payload}, $nonce, 'tick nonce received');
948 =head2 listen_for_binding($cb)
950 Helper function to evaluate whether sending KeyPress/KeyRelease events via XTEST
951 triggers an i3 key binding or not. Expects key bindings to be configured in the
952 form “bindsym <binding> nop <binding>”, e.g. “bindsym Mod4+Return nop
955 is(listen_for_binding(
957 xtest_key_press(133); # Super_L
958 xtest_key_press(36); # Return
959 xtest_key_release(36); # Return
960 xtest_key_release(133); # Super_L
965 'triggered the "Mod4+Return" keybinding');
969 sub listen_for_binding {
971 my $triggered = AnyEvent->condvar;
972 my @events = events_for(
976 $tester->is_eq(scalar @events, 1, 'Received precisely one event');
977 $tester->is_eq($events[0]->{change}, 'run', 'change is "run"');
978 # We look at the command (which is “nop <binding>”) because that is easier
979 # than re-assembling the string representation of $event->{binding}.
980 my $command = $events[0]->{binding}->{command};
981 $command =~ s/^nop //g;
987 Michael Stapelberg <michael@i3wm.org>
992 use parent 'X11::XCB::Connection';
996 i3test::sync_with_i3();
998 return $self->SUPER::input_focus(@_);