mirror of
https://gitlab.freedesktop.org/wayland/wayland.git
synced 2026-02-26 01:40:41 -05:00
client: Add message observer interface
Client message observers 2/6
Introduce a client message observer interface, strongly resembling the server
protocol logger interface added in commit 450f06e2.
This means a new pair of public API functions:
* wl_display_create_client_observer(): allows a client to register an observer
function, which is called for messages that are received or sent.
* wl_client_observer_destroy() which destroys the observer created by the prior
function.
With these changes, a client can set and clear an observer at run-time, and can
use it to log client messages to a location other than stderr.
The existing protocol-logger-test has also been revised and extended to demonstrate
using the new API for test use, to validate the sequence of messages sent and
received by the client, on top of the existing checks to do the same for the
server messages.
Signed-off-by: Lloyd Pique <lpique@google.com>
This commit is contained in:
Lloyd Pique
parent
66be76c169
commit
ed016b240f
3 changed files with 625 additions and 88 deletions
|
|
@ -29,12 +29,15 @@
|
|||
#include <string.h>
|
||||
#include <stdio.h>
|
||||
#include <sys/un.h>
|
||||
#include <time.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#include "wayland-client.h"
|
||||
#include "wayland-server.h"
|
||||
#include "test-runner.h"
|
||||
|
||||
#define ARRAY_LENGTH(a) (sizeof(a) / sizeof(a)[0])
|
||||
|
||||
/* Ensure the connection doesn't fail due to lack of XDG_RUNTIME_DIR. */
|
||||
static const char *
|
||||
require_xdg_runtime_dir(void)
|
||||
|
|
@ -45,57 +48,162 @@ require_xdg_runtime_dir(void)
|
|||
return val;
|
||||
}
|
||||
|
||||
struct compositor {
|
||||
struct wl_display *display;
|
||||
struct wl_event_loop *loop;
|
||||
int message;
|
||||
struct wl_client *client;
|
||||
};
|
||||
|
||||
struct message {
|
||||
struct expected_compositor_message {
|
||||
enum wl_protocol_logger_type type;
|
||||
const char *class;
|
||||
int opcode;
|
||||
const char *message_name;
|
||||
int args_count;
|
||||
} messages[] = {
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_REQUEST,
|
||||
.class = "wl_display",
|
||||
.opcode = 0,
|
||||
.message_name = "sync",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_EVENT,
|
||||
.class = "wl_callback",
|
||||
.opcode = 0,
|
||||
.message_name = "done",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_EVENT,
|
||||
.class = "wl_display",
|
||||
.opcode = 1,
|
||||
.message_name = "delete_id",
|
||||
.args_count = 1,
|
||||
},
|
||||
};
|
||||
|
||||
struct compositor {
|
||||
struct wl_display *display;
|
||||
struct wl_event_loop *loop;
|
||||
struct wl_protocol_logger *logger;
|
||||
|
||||
struct expected_compositor_message *expected_msg;
|
||||
int expected_msg_count;
|
||||
int actual_msg_count;
|
||||
struct wl_client *client;
|
||||
};
|
||||
|
||||
struct expected_client_message {
|
||||
enum wl_client_message_type type;
|
||||
enum wl_client_message_discarded_reason discarded_reason;
|
||||
const char *queue_name;
|
||||
const char *class;
|
||||
int opcode;
|
||||
const char *message_name;
|
||||
int args_count;
|
||||
};
|
||||
|
||||
struct client {
|
||||
struct wl_display *display;
|
||||
struct wl_callback *cb;
|
||||
struct wl_client_observer *sequence_observer;
|
||||
|
||||
struct expected_client_message *expected_msg;
|
||||
int expected_msg_count;
|
||||
int actual_msg_count;
|
||||
};
|
||||
|
||||
static int
|
||||
safe_strcmp(const char *s1, const char *s2) {
|
||||
if (s1 == NULL && s2 == NULL)
|
||||
return 0;
|
||||
if (s1 == NULL && s2 != NULL)
|
||||
return 1;
|
||||
if (s1 != NULL && s2 == NULL)
|
||||
return -1;
|
||||
return strcmp(s1, s2);
|
||||
}
|
||||
|
||||
#define ASSERT_LT(arg1, arg2, ...) \
|
||||
if (arg1 >= arg2) \
|
||||
fprintf(stderr, __VA_ARGS__); \
|
||||
assert(arg1 < arg2)
|
||||
|
||||
#define ASSERT_EQ(arg1, arg2, ...) \
|
||||
if (arg1 != arg2) \
|
||||
fprintf(stderr, __VA_ARGS__); \
|
||||
assert(arg1 == arg2)
|
||||
|
||||
#define ASSERT_STR_EQ(arg1, arg2, ...) \
|
||||
if (safe_strcmp(arg1, arg2) != 0) \
|
||||
fprintf(stderr, __VA_ARGS__); \
|
||||
assert(safe_strcmp(arg1, arg2) == 0)
|
||||
|
||||
static void
|
||||
logger_func(void *user_data, enum wl_protocol_logger_type type,
|
||||
const struct wl_protocol_logger_message *message)
|
||||
compositor_sequence_observer_func(
|
||||
void *user_data, enum wl_protocol_logger_type actual_type,
|
||||
const struct wl_protocol_logger_message *actual_msg)
|
||||
{
|
||||
struct compositor *c = user_data;
|
||||
struct message *msg = &messages[c->message++];
|
||||
struct expected_compositor_message *expected_msg;
|
||||
int actual_msg_count = c->actual_msg_count++;
|
||||
char details_msg[256];
|
||||
|
||||
assert(msg->type == type);
|
||||
assert(strcmp(msg->class, wl_resource_get_class(message->resource)) == 0);
|
||||
assert(msg->opcode == message->message_opcode);
|
||||
assert(strcmp(msg->message_name, message->message->name) == 0);
|
||||
assert(msg->args_count == message->arguments_count);
|
||||
c->client = wl_resource_get_client(actual_msg->resource);
|
||||
|
||||
c->client = wl_resource_get_client(message->resource);
|
||||
if (!c->expected_msg)
|
||||
return;
|
||||
|
||||
ASSERT_LT(actual_msg_count, c->expected_msg_count,
|
||||
"actual count %d exceeds expected count %d\n",
|
||||
actual_msg_count, c->expected_msg_count);
|
||||
|
||||
expected_msg = &c->expected_msg[actual_msg_count];
|
||||
|
||||
snprintf(details_msg, sizeof details_msg,
|
||||
"compositor msg %d of %d actual [%d, '%s', %d, '%s', %d] vs "
|
||||
"expected [%d, '%s', %d, '%s', %d]\n",
|
||||
c->actual_msg_count, c->expected_msg_count, actual_type,
|
||||
wl_resource_get_class(actual_msg->resource),
|
||||
actual_msg->message_opcode, actual_msg->message->name,
|
||||
actual_msg->arguments_count, expected_msg->type,
|
||||
expected_msg->class, expected_msg->opcode,
|
||||
expected_msg->message_name, expected_msg->args_count);
|
||||
|
||||
ASSERT_EQ(expected_msg->type, actual_type, "type mismatch: %s",
|
||||
details_msg);
|
||||
ASSERT_STR_EQ(expected_msg->class,
|
||||
wl_resource_get_class(actual_msg->resource),
|
||||
"class mismatch: %s", details_msg);
|
||||
ASSERT_EQ(expected_msg->opcode, actual_msg->message_opcode,
|
||||
"opcode mismatch: %s", details_msg);
|
||||
ASSERT_STR_EQ(expected_msg->message_name, actual_msg->message->name,
|
||||
"message name mismatch: %s", details_msg);
|
||||
ASSERT_EQ(expected_msg->args_count, actual_msg->arguments_count,
|
||||
"arg count mismatch: %s", details_msg);
|
||||
}
|
||||
|
||||
static void
|
||||
client_sequence_observer_func(
|
||||
void *user_data, enum wl_client_message_type actual_type,
|
||||
const struct wl_client_observed_message *actual_msg)
|
||||
{
|
||||
struct client *c = user_data;
|
||||
struct expected_client_message *expected_msg;
|
||||
int actual_msg_count = c->actual_msg_count++;
|
||||
char details_msg[256];
|
||||
|
||||
if (!c->expected_msg)
|
||||
return;
|
||||
|
||||
ASSERT_LT(actual_msg_count, c->expected_msg_count,
|
||||
"actual count %d exceeds expected count %d\n",
|
||||
actual_msg_count, c->expected_msg_count);
|
||||
expected_msg = &c->expected_msg[actual_msg_count];
|
||||
|
||||
snprintf(details_msg, sizeof details_msg,
|
||||
"client msg %d of %d actual [%d, %d, '%s', '%s', %d, '%s', %d] vs "
|
||||
"expected [%d, %d, '%s', '%s', %d, '%s', %d]\n",
|
||||
c->actual_msg_count, c->expected_msg_count, actual_type,
|
||||
actual_msg->discarded_reason,
|
||||
actual_msg->queue_name ? actual_msg->queue_name : "NULL",
|
||||
wl_proxy_get_class(actual_msg->proxy),
|
||||
actual_msg->message_opcode, actual_msg->message->name,
|
||||
actual_msg->arguments_count, expected_msg->type,
|
||||
expected_msg->discarded_reason,
|
||||
expected_msg->queue_name ? expected_msg->queue_name : "NULL",
|
||||
expected_msg->class, expected_msg->opcode,
|
||||
expected_msg->message_name, expected_msg->args_count);
|
||||
|
||||
ASSERT_EQ(expected_msg->type, actual_type, "type mismatch: %s",
|
||||
details_msg);
|
||||
ASSERT_EQ(expected_msg->discarded_reason, actual_msg->discarded_reason,
|
||||
"discarded reason mismatch: %s", details_msg);
|
||||
ASSERT_STR_EQ(expected_msg->queue_name, actual_msg->queue_name,
|
||||
"queue name mismatch: %s", details_msg);
|
||||
ASSERT_STR_EQ(expected_msg->class,
|
||||
wl_proxy_get_class(actual_msg->proxy),
|
||||
"class mismatch: %s", details_msg);
|
||||
ASSERT_EQ(expected_msg->opcode, actual_msg->message_opcode,
|
||||
"opcode mismatch: %s", details_msg);
|
||||
ASSERT_STR_EQ(expected_msg->message_name, actual_msg->message->name,
|
||||
"message name mismatch: %s", details_msg);
|
||||
ASSERT_EQ(expected_msg->args_count, actual_msg->arguments_count,
|
||||
"arg count mismatch: %s", details_msg);
|
||||
}
|
||||
|
||||
static void
|
||||
|
|
@ -108,41 +216,245 @@ static const struct wl_callback_listener callback_listener = {
|
|||
callback_done,
|
||||
};
|
||||
|
||||
static void
|
||||
logger_setup(struct compositor *compositor, struct client *client)
|
||||
{
|
||||
const char *socket;
|
||||
|
||||
require_xdg_runtime_dir();
|
||||
|
||||
compositor->display = wl_display_create();
|
||||
compositor->loop = wl_display_get_event_loop(compositor->display);
|
||||
socket = wl_display_add_socket_auto(compositor->display);
|
||||
|
||||
compositor->logger = wl_display_add_protocol_logger(
|
||||
compositor->display, compositor_sequence_observer_func,
|
||||
compositor);
|
||||
|
||||
client->display = wl_display_connect(socket);
|
||||
client->sequence_observer = wl_display_create_client_observer(
|
||||
client->display, client_sequence_observer_func, client);
|
||||
}
|
||||
|
||||
static void
|
||||
logger_teardown(struct compositor *compositor, struct client *client)
|
||||
{
|
||||
wl_client_observer_destroy(client->sequence_observer);
|
||||
wl_display_disconnect(client->display);
|
||||
|
||||
wl_client_destroy(compositor->client);
|
||||
wl_protocol_logger_destroy(compositor->logger);
|
||||
wl_display_destroy(compositor->display);
|
||||
}
|
||||
|
||||
TEST(logger)
|
||||
{
|
||||
test_set_timeout(1);
|
||||
|
||||
const char *socket;
|
||||
struct expected_compositor_message compositor_messages[] = {
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_REQUEST,
|
||||
.class = "wl_display",
|
||||
.opcode = 0,
|
||||
.message_name = "sync",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_EVENT,
|
||||
.class = "wl_callback",
|
||||
.opcode = 0,
|
||||
.message_name = "done",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_PROTOCOL_LOGGER_EVENT,
|
||||
.class = "wl_display",
|
||||
.opcode = 1,
|
||||
.message_name = "delete_id",
|
||||
.args_count = 1,
|
||||
},
|
||||
};
|
||||
struct expected_client_message client_messages[] = {
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_REQUEST,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 0,
|
||||
.message_name = "sync",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Display Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 1,
|
||||
.message_name = "delete_id",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_callback",
|
||||
.opcode = 0,
|
||||
.message_name = "done",
|
||||
.args_count = 1,
|
||||
},
|
||||
};
|
||||
struct compositor compositor = { 0 };
|
||||
struct {
|
||||
struct wl_display *display;
|
||||
struct wl_callback *cb;
|
||||
} client;
|
||||
struct wl_protocol_logger *logger;
|
||||
struct client client = { 0 };
|
||||
|
||||
require_xdg_runtime_dir();
|
||||
logger_setup(&compositor, &client);
|
||||
|
||||
compositor.display = wl_display_create();
|
||||
compositor.loop = wl_display_get_event_loop(compositor.display);
|
||||
socket = wl_display_add_socket_auto(compositor.display);
|
||||
compositor.expected_msg = &compositor_messages[0];
|
||||
compositor.expected_msg_count = ARRAY_LENGTH(compositor_messages);
|
||||
|
||||
logger = wl_display_add_protocol_logger(compositor.display,
|
||||
logger_func, &compositor);
|
||||
client.expected_msg = &client_messages[0];
|
||||
client.expected_msg_count = ARRAY_LENGTH(client_messages);
|
||||
|
||||
client.display = wl_display_connect(socket);
|
||||
client.cb = wl_display_sync(client.display);
|
||||
wl_callback_add_listener(client.cb, &callback_listener, NULL);
|
||||
wl_display_flush(client.display);
|
||||
|
||||
while (compositor.message < 3) {
|
||||
while (compositor.actual_msg_count < compositor.expected_msg_count) {
|
||||
wl_event_loop_dispatch(compositor.loop, -1);
|
||||
wl_display_flush_clients(compositor.display);
|
||||
}
|
||||
|
||||
wl_display_dispatch(client.display);
|
||||
wl_display_disconnect(client.display);
|
||||
while (client.actual_msg_count < client.expected_msg_count) {
|
||||
wl_display_dispatch(client.display);
|
||||
}
|
||||
|
||||
wl_client_destroy(compositor.client);
|
||||
wl_protocol_logger_destroy(logger);
|
||||
wl_display_destroy(compositor.display);
|
||||
logger_teardown(&compositor, &client);
|
||||
}
|
||||
|
||||
TEST(client_discards_if_dead_on_dispatch)
|
||||
{
|
||||
test_set_timeout(1);
|
||||
|
||||
struct expected_client_message client_messages[] = {
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_REQUEST,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 0,
|
||||
.message_name = "sync",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Display Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 1,
|
||||
.message_name = "delete_id",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason =
|
||||
WL_CLIENT_MESSAGE_DISCARD_DEAD_PROXY_ON_DISPATCH,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_callback",
|
||||
.opcode = 0,
|
||||
.message_name = "done",
|
||||
.args_count = 1,
|
||||
},
|
||||
};
|
||||
struct compositor compositor = { 0 };
|
||||
struct client client = { 0 };
|
||||
|
||||
logger_setup(&compositor, &client);
|
||||
|
||||
compositor.expected_msg_count = 3;
|
||||
|
||||
client.expected_msg = &client_messages[0];
|
||||
client.expected_msg_count = ARRAY_LENGTH(client_messages);
|
||||
|
||||
client.cb = wl_display_sync(client.display);
|
||||
wl_callback_add_listener(client.cb, &callback_listener, NULL);
|
||||
wl_display_flush(client.display);
|
||||
|
||||
while (compositor.actual_msg_count < compositor.expected_msg_count) {
|
||||
wl_event_loop_dispatch(compositor.loop, -1);
|
||||
wl_display_flush_clients(compositor.display);
|
||||
}
|
||||
|
||||
wl_display_prepare_read(client.display);
|
||||
wl_display_read_events(client.display);
|
||||
|
||||
// To get a WL_CLIENT_MESSAGE_DISCARD_DEAD_PROXY_ON_DISPATCH, we
|
||||
// destroy the callback after reading client events, but before
|
||||
// dispatching them.
|
||||
wl_callback_destroy(client.cb);
|
||||
|
||||
while (client.actual_msg_count < client.expected_msg_count) {
|
||||
wl_display_dispatch(client.display);
|
||||
}
|
||||
|
||||
logger_teardown(&compositor, &client);
|
||||
}
|
||||
|
||||
TEST(client_discards_if_no_listener_on_dispatch)
|
||||
{
|
||||
test_set_timeout(1);
|
||||
|
||||
struct expected_client_message client_messages[] = {
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_REQUEST,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 0,
|
||||
.message_name = "sync",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason = WL_CLIENT_MESSAGE_NOT_DISCARDED,
|
||||
.queue_name = "Display Queue",
|
||||
.class = "wl_display",
|
||||
.opcode = 1,
|
||||
.message_name = "delete_id",
|
||||
.args_count = 1,
|
||||
},
|
||||
{
|
||||
.type = WL_CLIENT_MESSAGE_EVENT,
|
||||
.discarded_reason =
|
||||
WL_CLIENT_MESSAGE_DISCARD_NO_LISTENER_ON_DISPATCH,
|
||||
.queue_name = "Default Queue",
|
||||
.class = "wl_callback",
|
||||
.opcode = 0,
|
||||
.message_name = "done",
|
||||
.args_count = 1,
|
||||
},
|
||||
};
|
||||
struct compositor compositor = { 0 };
|
||||
struct client client = { 0 };
|
||||
|
||||
logger_setup(&compositor, &client);
|
||||
|
||||
compositor.expected_msg_count = 3;
|
||||
|
||||
client.expected_msg = &client_messages[0];
|
||||
client.expected_msg_count = ARRAY_LENGTH(client_messages);
|
||||
|
||||
client.cb = wl_display_sync(client.display);
|
||||
wl_display_flush(client.display);
|
||||
|
||||
while (compositor.actual_msg_count < compositor.expected_msg_count) {
|
||||
wl_event_loop_dispatch(compositor.loop, -1);
|
||||
wl_display_flush_clients(compositor.display);
|
||||
}
|
||||
|
||||
while (client.actual_msg_count < client.expected_msg_count) {
|
||||
wl_display_dispatch(client.display);
|
||||
}
|
||||
|
||||
wl_callback_destroy(client.cb);
|
||||
|
||||
logger_teardown(&compositor, &client);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue