use X11::XCB::Window;
use X11::XCB qw(:all);
use AnyEvent::I3;
-use EV;
use List::Util qw(first);
use Time::HiRes qw(sleep);
use Cwd qw(abs_path);
+use Scalar::Util qw(blessed);
use SocketActivation;
use v5.10;
+# preload
+use Test::More ();
+use Data::Dumper ();
+
use Exporter ();
our @EXPORT = qw(
get_workspace_names
wait_for_event
wait_for_map
wait_for_unmap
+ $x
);
my $tester = Test::Builder->new();
my $_sync_window = undef;
my $tmp_socket_path = undef;
+our $x;
+
BEGIN {
my $window_count = 0;
sub counter_window {
}
}
+my $i3_pid;
+my $i3_autostart;
+
+END {
+
+ # testcases which start i3 manually should always call exit_gracefully
+ # on their own. Let’s see, whether they really did.
+ if (! $i3_autostart) {
+ return unless $i3_pid;
+
+ $tester->ok(undef, 'testcase called exit_gracefully()');
+ }
+
+ # don't trigger SIGCHLD handler
+ local $SIG{CHLD};
+
+ # From perldoc -v '$?':
+ # Inside an "END" subroutine $? contains the value
+ # that is going to be given to "exit()".
+ #
+ # Since waitpid sets $?, we need to localize it,
+ # otherwise TAP would be misinterpreted our return status
+ local $?;
+
+ # When measuring code coverage, try to exit i3 cleanly (otherwise, .gcda
+ # files are not written)
+ if ($ENV{COVERAGE} || $ENV{VALGRIND}) {
+ exit_gracefully($i3_pid, "/tmp/nested-$ENV{DISPLAY}");
+
+ } else {
+ kill(9, $i3_pid)
+ or $tester->BAIL_OUT("could not kill i3");
+
+ waitpid $i3_pid, 0;
+ }
+}
+
sub import {
- my $class = shift;
+ my ($class, %args) = @_;
my $pkg = caller;
- my $test_most_args = @_ ? "qw(@_)" : "";
+ $i3_autostart = delete($args{i3_autostart}) // 1;
+
+ my $cv = launch_with_config('-default', dont_block => 1)
+ if $i3_autostart;
+
+ my $test_more_args = '';
+ $test_more_args = join(' ', 'qw(', %args, ')') if keys %args;
local $@;
eval << "__";
package $pkg;
-use Test::Most $test_most_args;
+use Test::More $test_more_args;
use Data::Dumper;
use AnyEvent::I3;
use Time::HiRes qw(sleep);
-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);
-use v5.10;
-use strict;
-use warnings;
__
- $tester->bail_out("$@") if $@;
+ $tester->BAIL_OUT("$@") if $@;
+ feature->import(":5.10");
+ strict->import;
+ warnings->import;
+
+ $x ||= i3test::X11->new;
+ $cv->recv if $i3_autostart;
@_ = ($class);
goto \&Exporter::import;
# wait_for_event $x, 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
#
sub wait_for_event {
- my ($x, $timeout, $cb) = @_;
+ my ($timeout, $cb) = @_;
my $cv = AE::cv;
- my $prep = EV::prepare sub {
- $x->flush;
- };
+ $x->flush;
- my $check = EV::check sub {
+ # unfortunately, there is no constant for this
+ my $ae_read = 0;
+
+ my $guard = AE::io $x->get_file_descriptor, $ae_read, sub {
while (defined(my $event = $x->poll_for_event)) {
if ($cb->($event)) {
$cv->send(1);
}
};
- my $watcher = EV::io $x->get_file_descriptor, EV::READ, sub {
- # do nothing, we only need this watcher so that EV picks up the events
- };
-
# Trigger timeout after $timeout seconds (can be fractional)
my $t = AE::timer $timeout, 0, sub { warn "timeout ($timeout secs)"; $cv->send(0) };
my $result = $cv->recv;
undef $t;
+ undef $guard;
return $result;
}
# thin wrapper around wait_for_event which waits for MAP_NOTIFY
# make sure to include 'structure_notify' in the window’s event_mask attribute
sub wait_for_map {
- my ($x) = @_;
- wait_for_event $x, 2, sub { $_[0]->{response_type} == MAP_NOTIFY };
+ my ($win) = @_;
+ my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
+ wait_for_event 2, sub {
+ $_[0]->{response_type} == MAP_NOTIFY and $_[0]->{window} == $id
+ };
}
# Wrapper around wait_for_event which waits for UNMAP_NOTIFY. Also calls
# sync_with_i3 to make sure i3 also picked up and processed the UnmapNotify
# event.
sub wait_for_unmap {
- my ($x) = @_;
- wait_for_event $x, 2, sub { $_[0]->{response_type} == UNMAP_NOTIFY };
- sync_with_i3($x);
+ my ($win) = @_;
+ # my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
+ wait_for_event 2, sub {
+ $_[0]->{response_type} == UNMAP_NOTIFY # and $_[0]->{window} == $id
+ };
+ sync_with_i3();
}
#
#
# set dont_map to a true value to avoid mapping
#
+# if you want to change aspects of your window before it would be mapped,
+# set before_map to a coderef. $window gets passed as $_ and as first argument.
+#
+# if you set both dont_map and before_map, the coderef will be called nevertheless
+#
+#
# default values:
# class => WINDOW_CLASS_INPUT_OUTPUT
# rect => [ 0, 0, 30, 30 ]
# name => 'Window <n>'
#
sub open_window {
- my ($x, $args) = @_;
- my %args = ($args ? %$args : ());
+ my %args = @_ == 1 ? %{$_[0]} : @_;
my $dont_map = delete $args{dont_map};
+ my $before_map = delete $args{before_map};
$args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
$args{rect} //= [ 0, 0, 30, 30 ];
my $window = $x->root->create_child(%args);
+ if ($before_map) {
+ # TODO: investigate why _create is not needed
+ $window->_create;
+ $before_map->($window) for $window;
+ }
+
return $window if $dont_map;
$window->map;
- wait_for_map($x);
- # We sync with i3 here to make sure $x->input_focus is updated.
- sync_with_i3($x);
+ wait_for_map($window);
return $window;
}
# Thin wrapper around open_window which sets window_type to
# _NET_WM_WINDOW_TYPE_UTILITY to make the window floating.
sub open_floating_window {
- my ($x, $args) = @_;
- my %args = ($args ? %$args : ());
+ my %args = @_ == 1 ? %{$_[0]} : @_;
$args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
- return open_window($x, \%args);
+ return open_window(\%args);
}
sub open_empty_con {
my ($i3) = @_;
my $reply = $i3->command('open')->recv;
- return $reply->{id};
+ return $reply->[0]->{id};
}
sub get_workspace_names {
my @outputs = @{$tree->{nodes}};
my @cons;
for my $output (@outputs) {
+ next if $output->{name} eq '__i3';
# get the first CT_CON of each output
my $content = first { $_->{type} == 2 } @{$output->{nodes}};
@cons = (@cons, @{$content->{nodes}});
$tmp
}
+=head2 fresh_workspace(...)
+
+Switches to an unused workspace and returns the name of that workspace.
+
+Optionally switches to the specified output first.
+
+ my $ws = fresh_workspace;
+
+ # Get a fresh workspace on the second output.
+ my $ws = fresh_workspace(output => 1);
+
+=cut
sub fresh_workspace {
+ my %args = @_;
+ if (exists($args{output})) {
+ my $i3 = i3(get_socket_path());
+ my $tree = $i3->get_tree->recv;
+ my $output = first { $_->{name} eq "xinerama-$args{output}" }
+ @{$tree->{nodes}};
+ die "BUG: Could not find output $args{output}" unless defined($output);
+ # Get the focused workspace on that output and switch to it.
+ my $content = first { $_->{type} == 2 } @{$output->{nodes}};
+ my $focused = $content->{focus}->[0];
+ my $workspace = first { $_->{id} == $focused } @{$content->{nodes}};
+ $workspace = $workspace->{name};
+ cmd("workspace $workspace");
+ }
+
my $unused = get_unused_workspace;
cmd("workspace $unused");
$unused
@{$output->{nodes}});
} elsif ($which eq 'top') {
my $first = first { $_->{type} == 5 } @{$output->{nodes}};
- @docked = (@docked, @{$first->{nodes}});
+ @docked = (@docked, @{$first->{nodes}}) if defined($first);
} elsif ($which eq 'bottom') {
my @matching = grep { $_->{type} == 5 } @{$output->{nodes}};
my $last = $matching[-1];
- @docked = (@docked, @{$last->{nodes}});
+ @docked = (@docked, @{$last->{nodes}}) if defined($last);
}
}
return @docked;
($name ~~ @{get_workspace_names()})
}
+=head2 focused_ws
+
+Returns the name of the currently focused workspace.
+
+=cut
sub focused_ws {
my $i3 = i3(get_socket_path());
my $tree = $i3->get_tree->recv;
- my @outputs = @{$tree->{nodes}};
- my @cons;
- for my $output (@outputs) {
- # get the first CT_CON of each output
- my $content = first { $_->{type} == 2 } @{$output->{nodes}};
- my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
- return $first->{name}
- }
+ my $focused = $tree->{focus}->[0];
+ my $output = first { $_->{id} == $focused } @{$tree->{nodes}};
+ my $content = first { $_->{type} == 2 } @{$output->{nodes}};
+ my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
+ return $first->{name}
}
#
# See also docs/testsuite for a long explanation
#
sub sync_with_i3 {
- my ($x) = @_;
-
# Since we need a (mapped) window for receiving a ClientMessage, we create
# one on the first call of sync_with_i3. It will be re-used in all
# subsequent calls.
if (!defined($_sync_window)) {
- $_sync_window = $x->root->create_child(
- class => WINDOW_CLASS_INPUT_OUTPUT,
- rect => X11::XCB::Rect->new(x => -15, y => -15, width => 10, height => 10 ),
+ $_sync_window = open_window(
+ rect => [ -15, -15, 10, 10 ],
override_redirect => 1,
- background_color => '#ff0000',
- event_mask => [ 'structure_notify' ],
);
-
- $_sync_window->map;
-
- wait_for_event $x, 2, sub { $_[0]->{response_type} == MAP_NOTIFY };
}
my $root = $x->get_root_window();
$x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
# now wait until the reply is here
- return wait_for_event $x, 2, sub {
+ return wait_for_event 2, sub {
my ($event) = @_;
# TODO: const
return 0 unless $event->{response_type} == 161;
};
if (!$exited) {
- kill(9, $pid) or die "could not kill i3";
+ kill(9, $pid)
+ or $tester->BAIL_OUT("could not kill i3");
}
if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
unlink($socketpath);
}
+
+ waitpid $pid, 0;
+ undef $i3_pid;
}
# Gets the socket path from the I3_SOCKET_PATH atom stored on the X11 root window
return $_cached_socket_path;
}
- my $x = X11::XCB::Connection->new;
my $atom = $x->atom(name => 'I3_SOCKET_PATH');
my $cookie = $x->get_property(0, $x->get_root_window(), $atom->id, GET_PROPERTY_TYPE_ANY, 0, 256);
my $reply = $x->get_property_reply($cookie->{sequence});
my $socketpath = $reply->{value};
+ if ($socketpath eq "/tmp/nested-$ENV{DISPLAY}") {
+ $socketpath .= '-activation';
+ }
$_cached_socket_path = $socketpath;
return $socketpath;
}
#
# launches a new i3 process with the given string as configuration file.
# useful for tests which test specific config file directives.
-#
-# be sure to use !NO_I3_INSTANCE! somewhere in the file to signal
-# complete-run.pl that it should not create an instance of i3
-#
sub launch_with_config {
- my ($config, $dont_add_socket_path) = @_;
+ my ($config, %args) = @_;
+
+ $tmp_socket_path = "/tmp/nested-$ENV{DISPLAY}";
- $dont_add_socket_path //= 0;
+ $args{dont_create_temp_dir} //= 0;
- if (!defined($tmp_socket_path)) {
- $tmp_socket_path = File::Temp::tempnam('/tmp', 'i3-test-socket-');
+ my ($fh, $tmpfile) = tempfile("i3-cfg-for-$ENV{TESTNAME}-XXXXX", UNLINK => 1);
+
+ if ($config ne '-default') {
+ say $fh $config;
+ } else {
+ open(my $conf_fh, '<', './i3-test.config')
+ or $tester->BAIL_OUT("could not open default config: $!");
+ local $/;
+ say $fh scalar <$conf_fh>;
}
- my ($fh, $tmpfile) = tempfile('/tmp/i3-test-config-XXXXX', UNLINK => 1);
- say $fh $config;
- say $fh "ipc-socket $tmp_socket_path" unless $dont_add_socket_path;
+ say $fh "ipc-socket $tmp_socket_path"
+ unless $args{dont_add_socket_path};
+
close($fh);
my $cv = AnyEvent->condvar;
- my $pid = activate_i3(
+ $i3_pid = activate_i3(
unix_socket_path => "$tmp_socket_path-activation",
display => $ENV{DISPLAY},
configfile => $tmpfile,
testname => $ENV{TESTNAME},
valgrind => $ENV{VALGRIND},
strace => $ENV{STRACE},
+ restart => $ENV{RESTART},
cv => $cv,
+ dont_create_temp_dir => $args{dont_create_temp_dir},
);
+ # force update of the cached socket path in lib/i3test
+ # as soon as i3 has started
+ $cv->cb(sub { get_socket_path(0) });
+
+ return $cv if $args{dont_block};
+
# blockingly wait until i3 is ready
$cv->recv;
- # force update of the cached socket path in lib/i3test
- get_socket_path(0);
-
- return $pid;
+ return $i3_pid;
}
package i3test::X11;
sub input_focus {
my $self = shift;
- i3test::sync_with_i3($self);
+ i3test::sync_with_i3();
return $self->SUPER::input_focus(@_);
}
projects / i3 / i3 / blobdiff