Add GTestDBus object

This is a helper to write unit tests using a private dbus-daemon.

https://bugzilla.gnome.org/show_bug.cgi?id=672985
This commit is contained in:
Xavier Claessens 2012-04-18 23:21:13 +02:00
parent 2e3d50631f
commit 95bf3d1194
10 changed files with 818 additions and 0 deletions

View File

@ -230,6 +230,10 @@
<xi:include href="xml/gdbus-codegen.xml"/>
<xi:include href="gresource.xml"/>
</chapter>
<chapter id="testing">
<title>GIO Testing</title>
<xi:include href="xml/gtestdbus.xml"/>
</chapter>
</part>
<part id="migrating">

View File

@ -3870,3 +3870,21 @@ g_resource_flags_get_type
g_resource_lookup_flags_get_type
g_resource_error_quark
</SECTION>
<SECTION>
<FILE>gtestdbus</FILE>
<TITLE>GTestDBus</TITLE>
GTestDBus
GTestDBusFlags
g_test_dbus_new
g_test_dbus_get_flags
g_test_dbus_get_bus_address
g_test_dbus_add_service_dir
g_test_dbus_up
g_test_dbus_stop
g_test_dbus_down
g_test_dbus_unset
<SUBSECTION Private>
g_test_dbus_get_type
g_test_dbus_flags_get_type
</SECTION>

View File

@ -133,3 +133,5 @@ g_menu_attribute_iter_get_type
g_menu_link_iter_get_type
g_menu_get_type
g_menu_item_get_type
g_test_dbus_get_type
g_test_dbus_flags_get_type

View File

@ -65,6 +65,7 @@ gdbus_headers = \
gdbusobjectmanager.h \
gdbusobjectmanagerclient.h \
gdbusobjectmanagerserver.h \
gtestdbus.h \
$(NULL)
gdbus_sources = \
@ -94,6 +95,7 @@ gdbus_sources = \
gdbusobjectmanager.h gdbusobjectmanager.c \
gdbusobjectmanagerclient.h gdbusobjectmanagerclient.c \
gdbusobjectmanagerserver.h gdbusobjectmanagerserver.c \
gtestdbus.h gtestdbus.c \
$(NULL)
settings_headers = \

View File

@ -124,6 +124,7 @@
#include <gio/gsrvtarget.h>
#include <gio/gtcpconnection.h>
#include <gio/gtcpwrapperconnection.h>
#include <gio/gtestdbus.h>
#include <gio/gthemedicon.h>
#include <gio/gthreadedsocketservice.h>
#include <gio/gtlsbackend.h>

View File

@ -1721,3 +1721,13 @@ g_resolver_lookup_records
g_resolver_lookup_records_async
g_resolver_lookup_records_finish
g_resolver_record_type_get_type
g_test_dbus_add_service_dir
g_test_dbus_flags_get_type
g_test_dbus_get_bus_address
g_test_dbus_get_flags
g_test_dbus_get_type
g_test_dbus_new
g_test_dbus_down
g_test_dbus_stop
g_test_dbus_up
g_test_dbus_unset

View File

@ -1640,6 +1640,18 @@ typedef enum {
G_SOCKET_CLIENT_COMPLETE
} GSocketClientEvent;
/**
* GTestDBusFlags:
* @G_TEST_DBUS_NONE: No flags.
*
* Flags to define future #GTestDBus behaviour.
*
* Since: 2.34
*/
typedef enum /*< flags >*/ {
G_TEST_DBUS_NONE = 0,
} GTestDBusFlags;
G_END_DECLS
#endif /* __GIO_ENUMS_H__ */

View File

@ -465,6 +465,8 @@ typedef GType (*GDBusProxyTypeFunc) (GDBusObjectManagerClient *manager,
const gchar *interface_name,
gpointer user_data);
typedef struct _GTestDBus GTestDBus;
G_END_DECLS
#endif /* __GIO_TYPES_H__ */

693
gio/gtestdbus.c Normal file
View File

@ -0,0 +1,693 @@
/* GIO testing utilities
*
* Copyright (C) 2008-2010 Red Hat, Inc.
* Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* Authors: David Zeuthen <davidz@redhat.com>
* Xavier Claessens <xavier.claessens@collabora.co.uk>
*/
#include "config.h"
#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <glib.h>
#include "gdbusconnection.h"
#include "gdbusprivate.h"
#include "gfile.h"
#include "gioenumtypes.h"
#include "gtestdbus.h"
#include "glibintl.h"
/* -------------------------------------------------------------------------- */
/* Utility: Wait until object has a single ref */
typedef struct
{
GMainLoop *loop;
gboolean timed_out;
} WeakNotifyData;
static gboolean
on_weak_notify_timeout (gpointer user_data)
{
WeakNotifyData *data = user_data;
data->timed_out = TRUE;
g_main_loop_quit (data->loop);
return FALSE;
}
static gboolean
unref_on_idle (gpointer object)
{
g_object_unref (object);
return FALSE;
}
gboolean
_g_object_unref_and_wait_weak_notify (gpointer object)
{
WeakNotifyData data;
guint timeout_id;
data.loop = g_main_loop_new (NULL, FALSE);
data.timed_out = FALSE;
g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);
/* Drop the ref in an idle callback, this is to make sure the mainloop
* is already running when weak notify happens */
g_idle_add (unref_on_idle, object);
/* Make sure we don't block forever */
timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);
g_main_loop_run (data.loop);
g_source_remove (timeout_id);
if (data.timed_out)
{
g_warning ("Weak notify timeout, object ref_count=%d\n",
G_OBJECT (object)->ref_count);
}
return data.timed_out;
}
/* -------------------------------------------------------------------------- */
/* Utilities to cleanup the mess in the case unit test process crash */
#define ADD_PID_FORMAT "add pid %d\n"
#define REMOVE_PID_FORMAT "remove pid %d\n"
static void
watch_parent (gint fd)
{
GIOChannel *channel;
GPollFD fds[1];
GArray *pids_to_kill;
channel = g_io_channel_unix_new (fd);
fds[0].fd = fd;
fds[0].events = G_IO_HUP | G_IO_IN;
fds[0].revents = 0;
pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));
do
{
gint num_events;
gchar *command = NULL;
guint pid;
guint n;
GError *error = NULL;
num_events = g_poll (fds, 1, -1);
if (num_events == 0)
continue;
if (fds[0].revents == G_IO_HUP)
{
/* Parent quit, cleanup the mess and exit */
for (n = 0; n < pids_to_kill->len; n++)
{
pid = g_array_index (pids_to_kill, guint, n);
g_print ("cleaning up pid %d\n", pid);
kill (pid, SIGTERM);
}
g_array_unref (pids_to_kill);
g_io_channel_shutdown (channel, FALSE, &error);
g_assert_no_error (error);
g_io_channel_unref (channel);
exit (0);
}
/* Read the command from the input */
g_io_channel_read_line (channel, &command, NULL, NULL, &error);
g_assert_no_error (error);
/* Check for known commands */
if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
{
g_array_append_val (pids_to_kill, pid);
}
else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
{
for (n = 0; n < pids_to_kill->len; n++)
{
if (g_array_index (pids_to_kill, guint, n) == pid)
{
g_array_remove_index (pids_to_kill, n);
pid = 0;
break;
}
}
if (pid != 0)
{
g_warning ("unknown pid %d to remove", pid);
}
}
else
{
g_warning ("unknown command from parent '%s'", command);
}
g_free (command);
}
while (TRUE);
}
static GIOChannel *
watcher_init (void)
{
static gsize started = 0;
static GIOChannel *channel = NULL;
if (g_once_init_enter (&started))
{
gint pipe_fds[2];
/* fork a child to clean up when we are killed */
if (pipe (pipe_fds) != 0)
{
g_warning ("pipe() failed: %m");
g_assert_not_reached ();
}
switch (fork ())
{
case -1:
g_warning ("fork() failed: %m");
g_assert_not_reached ();
break;
case 0:
/* child */
close (pipe_fds[1]);
watch_parent (pipe_fds[0]);
break;
default:
/* parent */
close (pipe_fds[0]);
channel = g_io_channel_unix_new (pipe_fds[1]);
}
g_once_init_leave (&started, 1);
}
return channel;
}
static void
watcher_send_command (const gchar *command)
{
GIOChannel *channel;
GError *error = NULL;
channel = watcher_init ();
g_io_channel_write_chars (channel, command, -1, NULL, &error);
g_assert_no_error (error);
g_io_channel_flush (channel, &error);
g_assert_no_error (error);
}
/* This could be interesting to expose in public API */
static void
_g_test_watcher_add_pid (GPid pid)
{
gchar *command;
command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
watcher_send_command (command);
g_free (command);
}
static void
_g_test_watcher_remove_pid (GPid pid)
{
gchar *command;
command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
watcher_send_command (command);
g_free (command);
}
/* -------------------------------------------------------------------------- */
/* GTestDBus object implementation */
/**
* SECTION:gtestdbus
* @short_description: D-Bus testing helper
* @include: gio/gio.h
*
* Helper to test D-Bus code wihtout messing up with user' session bus.
*/
typedef struct _GTestDBusClass GTestDBusClass;
typedef struct _GTestDBusPrivate GTestDBusPrivate;
/**
* GTestDBus:
*
* The #GTestDBus structure contains only private data and
* should only be accessed using the provided API.
*
* Since: 2.34
*/
struct _GTestDBus {
GObject parent;
GTestDBusPrivate *priv;
};
struct _GTestDBusClass {
GObjectClass parent_class;
};
struct _GTestDBusPrivate
{
GTestDBusFlags flags;
GPtrArray *service_dirs;
GPid bus_pid;
gchar *bus_address;
gboolean up;
};
enum
{
PROP_0,
PROP_FLAGS,
};
G_DEFINE_TYPE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
static void
g_test_dbus_init (GTestDBus *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self), G_TYPE_TEST_DBUS,
GTestDBusPrivate);
self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
}
static void
g_test_dbus_dispose (GObject *object)
{
GTestDBus *self = (GTestDBus *) object;
if (self->priv->up)
g_test_dbus_down (self);
G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
}
static void
g_test_dbus_finalize (GObject *object)
{
GTestDBus *self = (GTestDBus *) object;
g_ptr_array_unref (self->priv->service_dirs);
g_free (self->priv->bus_address);
G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
}
static void
g_test_dbus_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GTestDBus *self = (GTestDBus *) object;
switch (property_id)
{
case PROP_FLAGS:
g_value_set_flags (value, g_test_dbus_get_flags (self));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
g_test_dbus_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GTestDBus *self = (GTestDBus *) object;
switch (property_id)
{
case PROP_FLAGS:
self->priv->flags = g_value_get_flags (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
g_test_dbus_class_init (GTestDBusClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = g_test_dbus_dispose;
object_class->finalize = g_test_dbus_finalize;
object_class->get_property = g_test_dbus_get_property;
object_class->set_property = g_test_dbus_set_property;
g_type_class_add_private (object_class, sizeof (GTestDBusPrivate));
/**
* GTestDBus:flags:
*
* #GTestDBusFlags specifying the behaviour of the dbus session
*
* Since: 2.34
*/
g_object_class_install_property (object_class, PROP_FLAGS,
g_param_spec_flags ("flags",
P_("dbus session flags"),
P_("Flags specifying the behaviour of the dbus session"),
G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
}
static GFile *
write_config_file (GTestDBus *self)
{
GString *contents;
GFile *file;
GFileIOStream *iostream;
guint i;
GError *error = NULL;
file = g_file_new_tmp ("g-test-dbus-XXXXXX", &iostream, &error);
g_assert_no_error (error);
g_object_unref (iostream);
contents = g_string_new (NULL);
g_string_append (contents,
"<busconfig>\n"
" <type>session</type>\n"
" <listen>unix:tmpdir=/tmp</listen>\n");
for (i = 0; i < self->priv->service_dirs->len; i++)
{
const gchar *path = g_ptr_array_index (self->priv->service_dirs, i);
g_string_append_printf (contents,
" <servicedir>%s</servicedir>\n", path);
}
g_string_append (contents,
" <policy context=\"default\">\n"
" <!-- Allow everything to be sent -->\n"
" <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
" <!-- Allow everything to be received -->\n"
" <allow eavesdrop=\"true\"/>\n"
" <!-- Allow anyone to own anything -->\n"
" <allow own=\"*\"/>\n"
" </policy>\n"
"</busconfig>\n");
g_file_replace_contents (file, contents->str, contents->len,
NULL, FALSE, G_FILE_CREATE_NONE, NULL, NULL, &error);
g_assert_no_error (error);
g_string_free (contents, TRUE);
return file;
}
static void
start_daemon (GTestDBus *self)
{
gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
GFile *file;
gchar *config_path;
gchar *config_arg;
gint stdout_fd;
GIOChannel *channel;
gsize termpos;
GError *error = NULL;
/* Write config file and set its path in argv */
file = write_config_file (self);
config_path = g_file_get_path (file);
config_arg = g_strdup_printf ("--config-file=%s", config_path);
argv[2] = config_arg;
/* Spawn dbus-daemon */
g_spawn_async_with_pipes (NULL,
argv,
NULL,
G_SPAWN_SEARCH_PATH,
NULL,
NULL,
&self->priv->bus_pid,
NULL,
&stdout_fd,
NULL,
&error);
g_assert_no_error (error);
_g_test_watcher_add_pid (self->priv->bus_pid);
/* Read bus address from daemon' stdout */
channel = g_io_channel_unix_new (stdout_fd);
g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
&termpos, &error);
g_assert_no_error (error);
self->priv->bus_address[termpos] = '\0';
/* start dbus-monitor */
if (g_getenv ("G_DBUS_MONITOR") != NULL)
{
gchar *command;
command = g_strdup_printf ("dbus-monitor --address %s",
self->priv->bus_address);
g_spawn_command_line_async (command, NULL);
g_free (command);
usleep (500 * 1000);
}
/* Cleanup */
g_io_channel_shutdown (channel, FALSE, &error);
g_assert_no_error (error);
g_io_channel_unref (channel);
g_file_delete (file, NULL, &error);
g_assert_no_error (error);
g_object_unref (file);
g_free (config_path);
g_free (config_arg);
}
static void
stop_daemon (GTestDBus *self)
{
kill (self->priv->bus_pid, SIGTERM);
_g_test_watcher_remove_pid (self->priv->bus_pid);
self->priv->bus_pid = 0;
g_free (self->priv->bus_address);
self->priv->bus_address = NULL;
}
/**
* g_test_dbus_new:
* @flags: a #GTestDBusFlags
*
* Create a new #GTestDBus object.
*
* Returns: (transfer full): a new #GTestDBus.
*/
GTestDBus *
g_test_dbus_new (GTestDBusFlags flags)
{
return g_object_new (G_TYPE_TEST_DBUS,
"flags", flags,
NULL);
}
/**
* g_test_dbus_get_flags:
* @self: a #GTestDBus
*
* Returns: the value of #GTestDBus:flags property
*/
GTestDBusFlags
g_test_dbus_get_flags (GTestDBus *self)
{
g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
return self->priv->flags;
}
/**
* g_test_dbus_get_bus_address:
* @self: a #GTestDBus
*
* Get the address on which dbus-daemon is running. if g_test_dbus_up() has not
* been called yet, %NULL is returned. This can be used with
* g_dbus_connection_new_for_address()
*
* Returns: the address of the bus, or %NULL.
*/
const gchar *
g_test_dbus_get_bus_address (GTestDBus *self)
{
g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
return self->priv->bus_address;
}
/**
* g_test_dbus_add_service_dir:
* @self: a #GTestDBus
* @path: path to a directory containing .service files
*
* Add a path where dbus-daemon will lookup for .services files. This can't be
* called after g_test_dbus_up().
*/
void
g_test_dbus_add_service_dir (GTestDBus *self,
const gchar *path)
{
g_return_if_fail (G_IS_TEST_DBUS (self));
g_return_if_fail (self->priv->bus_address == NULL);
g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
}
/**
* g_test_dbus_up:
* @self: a #GTestDBus
*
* Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
* call, it is safe for unit tests to start sending messages on the session bug.
*
* If this function is called from setup callback of g_test_add(),
* g_test_dbus_down() must be called in its teardown callback.
*
* If this function is called from unit test's main(), then g_test_dbus_down()
* must be called after g_test_run().
*/
void
g_test_dbus_up (GTestDBus *self)
{
g_return_if_fail (G_IS_TEST_DBUS (self));
g_return_if_fail (self->priv->bus_address == NULL);
g_return_if_fail (!self->priv->up);
start_daemon (self);
g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
self->priv->up = TRUE;
}
/**
* g_test_dbus_stop:
* @self: a #GTestDBus
*
* Stop the session bus started by g_test_dbus_up().
*
* Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
* singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
* tests wanting to verify behaviour after the session bus has been stopped
* can use this function but should still call g_test_dbus_down() when done.
*/
void
g_test_dbus_stop (GTestDBus *self)
{
g_return_if_fail (G_IS_TEST_DBUS (self));
g_return_if_fail (self->priv->bus_address != NULL);
stop_daemon (self);
}
/**
* g_test_dbus_down:
* @self: a #GTestDBus
*
* Stop the session bus started by g_test_dbus_up().
*
* This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
* is destroyed. This is done to ensure that the next unit test won't get a
* leaked singleton from this test.
*/
void
g_test_dbus_down (GTestDBus *self)
{
GDBusConnection *connection;
g_return_if_fail (G_IS_TEST_DBUS (self));
g_return_if_fail (self->priv->up);
connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
if (connection != NULL)
g_dbus_connection_set_exit_on_close (connection, FALSE);
if (self->priv->bus_address != NULL)
stop_daemon (self);
if (connection != NULL)
_g_object_unref_and_wait_weak_notify (connection);
g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
self->priv->up = FALSE;
}
/**
* g_test_dbus_unset:
*
* Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
* won't use user's session bus.
*
* This is useful for unit tests that want to verify behaviour when no session
* bus is running. It is not necessary to call this if unit test already calls
* g_test_dbus_up() before acquiring the session bus.
*/
void
g_test_dbus_unset (void)
{
g_unsetenv ("DISPLAY");
g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
}

74
gio/gtestdbus.h Normal file
View File

@ -0,0 +1,74 @@
/* GIO testing utilities
*
* Copyright (C) 2008-2010 Red Hat, Inc.
* Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* Authors: David Zeuthen <davidz@redhat.com>
* Xavier Claessens <xavier.claessens@collabora.co.uk>
*/
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#ifndef __G_TEST_DBUS_H__
#define __G_TEST_DBUS_H__
#include <gio/giotypes.h>
G_BEGIN_DECLS
#define G_TYPE_TEST_DBUS \
(g_test_dbus_get_type ())
#define G_TEST_DBUS(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_TEST_DBUS, \
GTestDbus))
#define G_IS_TEST_DBUS(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_TEST_DBUS))
GLIB_AVAILABLE_IN_2_34
GType g_test_dbus_get_type (void) G_GNUC_CONST;
GLIB_AVAILABLE_IN_2_34
GTestDBus * g_test_dbus_new (GTestDBusFlags flags);
GLIB_AVAILABLE_IN_2_34
GTestDBusFlags g_test_dbus_get_flags (GTestDBus *self);
GLIB_AVAILABLE_IN_2_34
const gchar * g_test_dbus_get_bus_address (GTestDBus *self);
GLIB_AVAILABLE_IN_2_34
void g_test_dbus_add_service_dir (GTestDBus *self,
const gchar *path);
GLIB_AVAILABLE_IN_2_34
void g_test_dbus_up (GTestDBus *self);
GLIB_AVAILABLE_IN_2_34
void g_test_dbus_stop (GTestDBus *self);
GLIB_AVAILABLE_IN_2_34
void g_test_dbus_down (GTestDBus *self);
GLIB_AVAILABLE_IN_2_34
void g_test_dbus_unset (void);
G_END_DECLS
#endif /* __G_TEST_DBUS_H__ */