git.sur5r.net Git - i3/i3/blob - testcases/t/lib/i3test.pm

   1 package i3test;
   2 # vim:ts=4:sw=4:expandtab
   3
   4 use File::Temp qw(tmpnam tempfile tempdir);
   5 use Test::Builder;
   6 use X11::XCB::Rect;
   7 use X11::XCB::Window;
   8 use X11::XCB qw(:all);
   9 use AnyEvent::I3;
  10 use EV;
  11 use List::Util qw(first);
  12 use List::MoreUtils qw(lastval);
  13 use Time::HiRes qw(sleep);
  14 use Try::Tiny;
  15 use Cwd qw(abs_path);
  16 use Proc::Background;
  17
  18 use v5.10;
  19
  20 use Exporter ();
  21 our @EXPORT = qw(
  22     get_workspace_names
  23     get_unused_workspace
  24     fresh_workspace
  25     get_ws_content
  26     get_ws
  27     get_focused
  28     open_empty_con
  29     open_window
  30     open_floating_window
  31     get_dock_clients
  32     cmd
  33     sync_with_i3
  34     does_i3_live
  35     exit_gracefully
  36     workspace_exists
  37     focused_ws
  38     get_socket_path
  39     launch_with_config
  40     wait_for_event
  41     wait_for_map
  42     wait_for_unmap
  43 );
  44
  45 my $tester = Test::Builder->new();
  46 my $_cached_socket_path = undef;
  47 my $_sync_window = undef;
  48 my $tmp_socket_path = undef;
  49
  50 BEGIN {
  51     my $window_count = 0;
  52     sub counter_window {
  53         return $window_count++;
  54     }
  55 }
  56
  57 sub import {
  58     my $class = shift;
  59     my $pkg = caller;
  60     eval "package $pkg;
  61 use Test::Most" . (@_ > 0 ? " qw(@_)" : "") . ";
  62 use Data::Dumper;
  63 use AnyEvent::I3;
  64 use Time::HiRes qw(sleep);
  65 use Test::Deep qw(eq_deeply cmp_deeply cmp_set cmp_bag cmp_methods useclass noclass set bag subbagof superbagof subsetof supersetof superhashof subhashof bool str arraylength Isa ignore methods regexprefonly regexpmatches num regexponly scalref reftype hashkeysonly blessed array re hash regexpref hash_each shallow array_each code arrayelementsonly arraylengthonly scalarrefonly listmethods any hashkeys isa);
  66 use v5.10;
  67 use strict;
  68 use warnings;
  69 ";
  70     @_ = ($class);
  71     goto \&Exporter::import;
  72 }
  73
  74 #
  75 # Waits for the next event and calls the given callback for every event to
  76 # determine if this is the event we are waiting for.
  77 #
  78 # Can be used to wait until a window is mapped, until a ClientMessage is
  79 # received, etc.
  80 #
  81 # wait_for_event $x, 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
  82 #
  83 sub wait_for_event {
  84     my ($x, $timeout, $cb) = @_;
  85
  86     my $cv = AE::cv;
  87
  88     my $prep = EV::prepare sub {
  89         $x->flush;
  90     };
  91
  92     my $check = EV::check sub {
  93         while (defined(my $event = $x->poll_for_event)) {
  94             if ($cb->($event)) {
  95                 $cv->send(1);
  96                 last;
  97             }
  98         }
  99     };
 100
 101     my $watcher = EV::io $x->get_file_descriptor, EV::READ, sub {
 102         # do nothing, we only need this watcher so that EV picks up the events
 103     };
 104
 105     # Trigger timeout after $timeout seconds (can be fractional)
 106     my $timeout = AE::timer $timeout, 0, sub { warn "timeout"; $cv->send(0) };
 107
 108     my $result = $cv->recv;
 109     return $result;
 110 }
 111
 112 # thin wrapper around wait_for_event which waits for MAP_NOTIFY
 113 # make sure to include 'structure_notify' in the window’s event_mask attribute
 114 sub wait_for_map {
 115     my ($x) = @_;
 116     wait_for_event $x, 1, sub { $_[0]->{response_type} == MAP_NOTIFY };
 117 }
 118
 119 # Wrapper around wait_for_event which waits for UNMAP_NOTIFY. Also calls
 120 # sync_with_i3 to make sure i3 also picked up and processed the UnmapNotify
 121 # event.
 122 sub wait_for_unmap {
 123     my ($x) = @_;
 124     wait_for_event $x, 1, sub { $_[0]->{response_type} == UNMAP_NOTIFY };
 125     sync_with_i3($x);
 126 }
 127
 128 #
 129 # Opens a new window (see X11::XCB::Window), maps it, waits until it got mapped
 130 # and synchronizes with i3.
 131 #
 132 # set dont_map to a true value to avoid mapping
 133 #
 134 # default values:
 135 #     class => WINDOW_CLASS_INPUT_OUTPUT
 136 #     rect => [ 0, 0, 30, 30 ]
 137 #     background_color => '#c0c0c0'
 138 #     event_mask => [ 'structure_notify' ]
 139 #     name => 'Window <n>'
 140 #
 141 sub open_window {
 142     my ($x, $args) = @_;
 143     my %args = ($args ? %$args : ());
 144
 145     my $dont_map = delete $args{dont_map};
 146
 147     $args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
 148     $args{rect} //= [ 0, 0, 30, 30 ];
 149     $args{background_color} //= '#c0c0c0';
 150     $args{event_mask} //= [ 'structure_notify' ];
 151     $args{name} //= 'Window ' . counter_window();
 152
 153     my $window = $x->root->create_child(%args);
 154
 155     return $window if $dont_map;
 156
 157     $window->map;
 158     wait_for_map($x);
 159     # We sync with i3 here to make sure $x->input_focus is updated.
 160     sync_with_i3($x);
 161     return $window;
 162 }
 163
 164 # Thin wrapper around open_window which sets window_type to
 165 # _NET_WM_WINDOW_TYPE_UTILITY to make the window floating.
 166 sub open_floating_window {
 167     my ($x, $args) = @_;
 168     my %args = ($args ? %$args : ());
 169
 170     $args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
 171
 172     return open_window($x, \%args);
 173 }
 174
 175 sub open_empty_con {
 176     my ($i3) = @_;
 177
 178     my $reply = $i3->command('open')->recv;
 179     return $reply->{id};
 180 }
 181
 182 sub get_workspace_names {
 183     my $i3 = i3(get_socket_path());
 184     my $tree = $i3->get_tree->recv;
 185     my @outputs = @{$tree->{nodes}};
 186     my @cons;
 187     for my $output (@outputs) {
 188         # get the first CT_CON of each output
 189         my $content = first { $_->{type} == 2 } @{$output->{nodes}};
 190         @cons = (@cons, @{$content->{nodes}});
 191     }
 192     [ map { $_->{name} } @cons ]
 193 }
 194
 195 sub get_unused_workspace {
 196     my @names = get_workspace_names();
 197     my $tmp;
 198     do { $tmp = tmpnam() } while ($tmp ~~ @names);
 199     $tmp
 200 }
 201
 202 sub fresh_workspace {
 203     my $unused = get_unused_workspace;
 204     cmd("workspace $unused");
 205     $unused
 206 }
 207
 208 sub get_ws {
 209     my ($name) = @_;
 210     my $i3 = i3(get_socket_path());
 211     my $tree = $i3->get_tree->recv;
 212
 213     my @outputs = @{$tree->{nodes}};
 214     my @workspaces;
 215     for my $output (@outputs) {
 216         # get the first CT_CON of each output
 217         my $content = first { $_->{type} == 2 } @{$output->{nodes}};
 218         @workspaces = (@workspaces, @{$content->{nodes}});
 219     }
 220
 221     # as there can only be one workspace with this name, we can safely
 222     # return the first entry
 223     return first { $_->{name} eq $name } @workspaces;
 224 }
 225
 226 #
 227 # returns the content (== tree, starting from the node of a workspace)
 228 # of a workspace. If called in array context, also includes the focus
 229 # stack of the workspace
 230 #
 231 sub get_ws_content {
 232     my ($name) = @_;
 233     my $con = get_ws($name);
 234     return wantarray ? ($con->{nodes}, $con->{focus}) : $con->{nodes};
 235 }
 236
 237 sub get_focused {
 238     my ($ws) = @_;
 239     my $con = get_ws($ws);
 240
 241     my @focused = @{$con->{focus}};
 242     my $lf;
 243     while (@focused > 0) {
 244         $lf = $focused[0];
 245         last unless defined($con->{focus});
 246         @focused = @{$con->{focus}};
 247         @cons = grep { $_->{id} == $lf } (@{$con->{nodes}}, @{$con->{'floating_nodes'}});
 248         $con = $cons[0];
 249     }
 250
 251     return $lf;
 252 }
 253
 254 sub get_dock_clients {
 255     my $which = shift;
 256
 257     my $tree = i3(get_socket_path())->get_tree->recv;
 258     my @outputs = @{$tree->{nodes}};
 259     # Children of all dockareas
 260     my @docked;
 261     for my $output (@outputs) {
 262         if (!defined($which)) {
 263             @docked = (@docked, map { @{$_->{nodes}} }
 264                                 grep { $_->{type} == 5 }
 265                                 @{$output->{nodes}});
 266         } elsif ($which eq 'top') {
 267             my $first = first { $_->{type} == 5 } @{$output->{nodes}};
 268             @docked = (@docked, @{$first->{nodes}});
 269         } elsif ($which eq 'bottom') {
 270             my $last = lastval { $_->{type} == 5 } @{$output->{nodes}};
 271             @docked = (@docked, @{$last->{nodes}});
 272         }
 273     }
 274     return @docked;
 275 }
 276
 277 sub cmd {
 278     i3(get_socket_path())->command(@_)->recv
 279 }
 280
 281 sub workspace_exists {
 282     my ($name) = @_;
 283     ($name ~~ @{get_workspace_names()})
 284 }
 285
 286 sub focused_ws {
 287     my $i3 = i3(get_socket_path());
 288     my $tree = $i3->get_tree->recv;
 289     my @outputs = @{$tree->{nodes}};
 290     my @cons;
 291     for my $output (@outputs) {
 292         # get the first CT_CON of each output
 293         my $content = first { $_->{type} == 2 } @{$output->{nodes}};
 294         my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
 295         return $first->{name}
 296     }
 297 }
 298
 299 #
 300 # Sends an I3_SYNC ClientMessage with a random value to the root window.
 301 # i3 will reply with the same value, but, due to the order of events it
 302 # processes, only after all other events are done.
 303 #
 304 # This can be used to ensure the results of a cmd 'focus left' are pushed to
 305 # X11 and that $x->input_focus returns the correct value afterwards.
 306 #
 307 # See also docs/testsuite for a long explanation
 308 #
 309 sub sync_with_i3 {
 310     my ($x) = @_;
 311
 312     # Since we need a (mapped) window for receiving a ClientMessage, we create
 313     # one on the first call of sync_with_i3. It will be re-used in all
 314     # subsequent calls.
 315     if (!defined($_sync_window)) {
 316         $_sync_window = $x->root->create_child(
 317             class => WINDOW_CLASS_INPUT_OUTPUT,
 318             rect => X11::XCB::Rect->new(x => -15, y => -15, width => 10, height => 10 ),
 319             override_redirect => 1,
 320             background_color => '#ff0000',
 321             event_mask => [ 'structure_notify' ],
 322         );
 323
 324         $_sync_window->map;
 325
 326         wait_for_event $x, 0.5, sub { $_[0]->{response_type} == MAP_NOTIFY };
 327     }
 328
 329     my $root = $x->get_root_window();
 330     # Generate a random number to identify this particular ClientMessage.
 331     my $myrnd = int(rand(255)) + 1;
 332
 333     # Generate a ClientMessage, see xcb_client_message_t
 334     my $msg = pack "CCSLLLLLLL",
 335          CLIENT_MESSAGE, # response_type
 336          32,     # format
 337          0,      # sequence
 338          $root,  # destination window
 339          $x->atom(name => 'I3_SYNC')->id,
 340
 341          $_sync_window->id,    # data[0]: our own window id
 342          $myrnd, # data[1]: a random value to identify the request
 343          0,
 344          0,
 345          0;
 346
 347     # Send it to the root window -- since i3 uses the SubstructureRedirect
 348     # event mask, it will get the ClientMessage.
 349     $x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
 350
 351     # now wait until the reply is here
 352     return wait_for_event $x, 1, sub {
 353         my ($event) = @_;
 354         # TODO: const
 355         return 0 unless $event->{response_type} == 161;
 356
 357         my ($win, $rnd) = unpack "LL", $event->{data};
 358         return ($rnd == $myrnd);
 359     };
 360 }
 361
 362 sub does_i3_live {
 363     my $tree = i3(get_socket_path())->get_tree->recv;
 364     my @nodes = @{$tree->{nodes}};
 365     my $ok = (@nodes > 0);
 366     $tester->ok($ok, 'i3 still lives');
 367     return $ok;
 368 }
 369
 370 # Tries to exit i3 gracefully (with the 'exit' cmd) or kills the PID if that fails
 371 sub exit_gracefully {
 372     my ($pid, $socketpath) = @_;
 373     $socketpath ||= get_socket_path();
 374
 375     my $exited = 0;
 376     try {
 377         say "Exiting i3 cleanly...";
 378         i3($socketpath)->command('exit')->recv;
 379         $exited = 1;
 380     };
 381
 382     if (!$exited) {
 383         kill(9, $pid) or die "could not kill i3";
 384     }
 385
 386     if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
 387         unlink($socketpath);
 388     }
 389 }
 390
 391 # Gets the socket path from the I3_SOCKET_PATH atom stored on the X11 root window
 392 sub get_socket_path {
 393     my ($cache) = @_;
 394     $cache ||= 1;
 395
 396     if ($cache && defined($_cached_socket_path)) {
 397         return $_cached_socket_path;
 398     }
 399
 400     my $x = X11::XCB::Connection->new;
 401     my $atom = $x->atom(name => 'I3_SOCKET_PATH');
 402     my $cookie = $x->get_property(0, $x->get_root_window(), $atom->id, GET_PROPERTY_TYPE_ANY, 0, 256);
 403     my $reply = $x->get_property_reply($cookie->{sequence});
 404     my $socketpath = $reply->{value};
 405     $_cached_socket_path = $socketpath;
 406     return $socketpath;
 407 }
 408
 409 #
 410 # launches a new i3 process with the given string as configuration file.
 411 # useful for tests which test specific config file directives.
 412 #
 413 # be sure to use !NO_I3_INSTANCE! somewhere in the file to signal
 414 # complete-run.pl that it should not create an instance of i3
 415 #
 416 sub launch_with_config {
 417     my ($config) = @_;
 418
 419     if (!defined($tmp_socket_path)) {
 420         $tmp_socket_path = File::Temp::tempnam('/tmp', 'i3-test-socket-');
 421     }
 422
 423     my ($fh, $tmpfile) = tempfile('i3-test-config-XXXXX', UNLINK => 1);
 424     say $fh $config;
 425     say $fh "ipc-socket $tmp_socket_path";
 426     close($fh);
 427
 428     # Use $ENV{LOGPATH}, gets set in complete-run.pl. We append instead of
 429     # overwrite because there might be multiple instances of i3 running during
 430     # one test case.
 431     my $i3cmd = "exec " . abs_path("../i3") . " -V -d all --disable-signalhandler -c $tmpfile >>$ENV{LOGPATH} 2>&1";
 432     my $process = Proc::Background->new($i3cmd);
 433     sleep 1.25;
 434
 435     # force update of the cached socket path in lib/i3test
 436     get_socket_path(0);
 437
 438     return $process;
 439 }
 440
 441 1