gio/gtestdbus.c

   1 /* GIO testing utilities
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General
  17  * Public License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: David Zeuthen <davidz@redhat.com>
  22  *          Xavier Claessens <xavier.claessens@collabora.co.uk>
  23  */
  24
  25 #include "config.h"
  26
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <gstdio.h>
  30 #ifdef G_OS_UNIX
  31 #include <unistd.h>
  32 #endif
  33 #ifdef G_OS_WIN32
  34 #include <io.h>
  35 #endif
  36
  37 #include <glib.h>
  38
  39 #include "gdbusconnection.h"
  40 #include "gdbusprivate.h"
  41 #include "gfile.h"
  42 #include "gioenumtypes.h"
  43 #include "gtestdbus.h"
  44
  45 #include "glibintl.h"
  46
  47 #ifdef G_OS_WIN32
  48 #include <windows.h>
  49 #endif
  50
  51 /* -------------------------------------------------------------------------- */
  52 /* Utility: Wait until object has a single ref  */
  53
  54 typedef struct
  55 {
  56   GMainLoop *loop;
  57   gboolean   timed_out;
  58 } WeakNotifyData;
  59
  60 static gboolean
  61 on_weak_notify_timeout (gpointer user_data)
  62 {
  63   WeakNotifyData *data = user_data;
  64   data->timed_out = TRUE;
  65   g_main_loop_quit (data->loop);
  66   return FALSE;
  67 }
  68
  69 static gboolean
  70 dispose_on_idle (gpointer object)
  71 {
  72   g_object_run_dispose (object);
  73   g_object_unref (object);
  74   return FALSE;
  75 }
  76
  77 static gboolean
  78 _g_object_dispose_and_wait_weak_notify (gpointer object)
  79 {
  80   WeakNotifyData data;
  81   guint timeout_id;
  82
  83   data.loop = g_main_loop_new (NULL, FALSE);
  84   data.timed_out = FALSE;
  85
  86   g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);
  87
  88   /* Drop the ref in an idle callback, this is to make sure the mainloop
  89    * is already running when weak notify happens */
  90   g_idle_add (dispose_on_idle, object);
  91
  92   /* Make sure we don't block forever */
  93   timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);
  94
  95   g_main_loop_run (data.loop);
  96
  97   if (data.timed_out)
  98     {
  99       g_warning ("Weak notify timeout, object ref_count=%d\n",
 100           G_OBJECT (object)->ref_count);
 101     }
 102   else
 103     {
 104       g_source_remove (timeout_id);
 105     }
 106
 107   g_main_loop_unref (data.loop);
 108   return data.timed_out;
 109 }
 110
 111 /* -------------------------------------------------------------------------- */
 112 /* Utilities to cleanup the mess in the case unit test process crash */
 113
 114 #ifdef G_OS_WIN32
 115
 116 /* This could be interesting to expose in public API */
 117 static void
 118 _g_test_watcher_add_pid (GPid pid)
 119 {
 120   static gsize started = 0;
 121   HANDLE job;
 122
 123   if (g_once_init_enter (&started))
 124     {
 125       JOBOBJECT_EXTENDED_LIMIT_INFORMATION info;
 126
 127       job = CreateJobObjectW (NULL, NULL);
 128       memset (&info, 0, sizeof (info));
 129       info.BasicLimitInformation.LimitFlags = 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;
 130
 131       if (!SetInformationJobObject(job, JobObjectExtendedLimitInformation, &info, sizeof (info)))
 132         g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));
 133
 134       g_once_init_leave (&started,(gsize)job);
 135     }
 136
 137   job = (HANDLE)started;
 138
 139   if (!AssignProcessToJobObject(job, pid))
 140     g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
 141 }
 142
 143 static void
 144 _g_test_watcher_remove_pid (GPid pid)
 145 {
 146   /* No need to unassign the process from the job object as the process
 147      will be killed anyway */
 148 }
 149
 150 #else
 151
 152 #define ADD_PID_FORMAT "add pid %d\n"
 153 #define REMOVE_PID_FORMAT "remove pid %d\n"
 154
 155 static void
 156 watch_parent (gint fd)
 157 {
 158   GIOChannel *channel;
 159   GPollFD fds[1];
 160   GArray *pids_to_kill;
 161
 162   channel = g_io_channel_unix_new (fd);
 163
 164   fds[0].fd = fd;
 165   fds[0].events = G_IO_HUP | G_IO_IN;
 166   fds[0].revents = 0;
 167
 168   pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));
 169
 170   do
 171     {
 172       gint num_events;
 173       gchar *command = NULL;
 174       guint pid;
 175       guint n;
 176       GError *error = NULL;
 177
 178       num_events = g_poll (fds, 1, -1);
 179       if (num_events == 0)
 180         continue;
 181
 182       if (fds[0].revents == G_IO_HUP)
 183         {
 184           /* Parent quit, cleanup the mess and exit */
 185           for (n = 0; n < pids_to_kill->len; n++)
 186             {
 187               pid = g_array_index (pids_to_kill, guint, n);
 188               g_print ("cleaning up pid %d\n", pid);
 189               kill (pid, SIGTERM);
 190             }
 191
 192           g_array_unref (pids_to_kill);
 193           g_io_channel_shutdown (channel, FALSE, &error);
 194           g_assert_no_error (error);
 195           g_io_channel_unref (channel);
 196
 197           exit (0);
 198         }
 199
 200       /* Read the command from the input */
 201       g_io_channel_read_line (channel, &command, NULL, NULL, &error);
 202       g_assert_no_error (error);
 203
 204       /* Check for known commands */
 205       if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
 206         {
 207           g_array_append_val (pids_to_kill, pid);
 208         }
 209       else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
 210         {
 211           for (n = 0; n < pids_to_kill->len; n++)
 212             {
 213               if (g_array_index (pids_to_kill, guint, n) == pid)
 214                 {
 215                   g_array_remove_index (pids_to_kill, n);
 216                   pid = 0;
 217                   break;
 218                 }
 219             }
 220           if (pid != 0)
 221             {
 222               g_warning ("unknown pid %d to remove", pid);
 223             }
 224         }
 225       else
 226         {
 227           g_warning ("unknown command from parent '%s'", command);
 228         }
 229
 230       g_free (command);
 231     }
 232   while (TRUE);
 233 }
 234
 235 static GIOChannel *
 236 watcher_init (void)
 237 {
 238   static gsize started = 0;
 239   static GIOChannel *channel = NULL;
 240
 241   if (g_once_init_enter (&started))
 242     {
 243       gint pipe_fds[2];
 244
 245       /* fork a child to clean up when we are killed */
 246       if (pipe (pipe_fds) != 0)
 247         {
 248           g_warning ("pipe() failed: %m");
 249           g_assert_not_reached ();
 250         }
 251
 252       switch (fork ())
 253         {
 254         case -1:
 255           g_warning ("fork() failed: %m");
 256           g_assert_not_reached ();
 257           break;
 258
 259         case 0:
 260           /* child */
 261           close (pipe_fds[1]);
 262           watch_parent (pipe_fds[0]);
 263           break;
 264
 265         default:
 266           /* parent */
 267           close (pipe_fds[0]);
 268           channel = g_io_channel_unix_new (pipe_fds[1]);
 269         }
 270
 271       g_once_init_leave (&started, 1);
 272     }
 273
 274   return channel;
 275 }
 276
 277 static void
 278 watcher_send_command (const gchar *command)
 279 {
 280   GIOChannel *channel;
 281   GError *error = NULL;
 282
 283   channel = watcher_init ();
 284
 285   g_io_channel_write_chars (channel, command, -1, NULL, &error);
 286   g_assert_no_error (error);
 287
 288   g_io_channel_flush (channel, &error);
 289   g_assert_no_error (error);
 290 }
 291
 292 /* This could be interesting to expose in public API */
 293 static void
 294 _g_test_watcher_add_pid (GPid pid)
 295 {
 296   gchar *command;
 297
 298   command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
 299   watcher_send_command (command);
 300   g_free (command);
 301 }
 302
 303 static void
 304 _g_test_watcher_remove_pid (GPid pid)
 305 {
 306   gchar *command;
 307
 308   command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
 309   watcher_send_command (command);
 310   g_free (command);
 311 }
 312
 313 #endif
 314
 315 /* -------------------------------------------------------------------------- */
 316 /* GTestDBus object implementation */
 317
 318 /**
 319  * SECTION:gtestdbus
 320  * @short_description: D-Bus testing helper
 321  * @include: gio/gio.h
 322  *
 323  * A helper class for testing code which uses D-Bus without touching the user's
 324  * session bus.
 325  *
 326  * Note that #GTestDBus modifies the user’s environment, calling setenv(). This
 327  * is not thread-safe, so all #GTestDBus calls should be completed before
 328  * threads are spawned, or should have appropriate locking to ensure no access
 329  * conflicts to environment variables shared between #GTestDBus and other
 330  * threads.
 331  *
 332  * <refsect2 id="gio-D-Bus-Test-Scaffolding">
 333  *   <title>Creating unit tests using GTestDBus</title>
 334  *   <para>
 335  *     Testing of D-Bus services can be tricky because normally we only ever run
 336  *     D-Bus services over an existing instance of the D-Bus daemon thus we
 337  *     usually don't activate D-Bus services that are not yet installed into the
 338  *     target system. The #GTestDBus object makes this easier for us by taking care
 339  *     of the lower level tasks such as running a private D-Bus daemon and looking
 340  *     up uninstalled services in customizable locations, typically in your source code tree.
 341  *   </para>
 342  *   <para>
 343  *     The first thing you will need is a separate service description file for the
 344  *     D-Bus daemon. Typically a <filename>services</filename> subdirectory of
 345  *     your <filename>tests</filename> directory
 346  *     is a good place to put this file.
 347  *   </para>
 348  *   <para>
 349  *     The service file should list your service along with an absolute path to the
 350  *     uninstalled service executable in your source tree. Using autotools we would
 351  *     achieve this by adding a file such as <filename>my-server.service.in</filename>
 352  *     in the services
 353  *     directory and have it processed by configure.
 354  *     <informalexample><programlisting>
 355  *     [D-BUS Service]
 356  *     Name=org.gtk.GDBus.Examples.ObjectManager
 357  *     Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
 358  *     </programlisting></informalexample>
 359  *     You will also need to indicate this service directory in your test
 360  *     fixtures, so you will need to pass the path while compiling your
 361  *     test cases. Typically this is done with autotools with an added
 362  *     preprocessor flag specified to compile your tests such as:
 363  *     <informalexample><programlisting>
 364  *     -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
 365  *     </programlisting></informalexample>
 366  *   </para>
 367  *   <para>
 368  *     Once you have a service definition file which is local to your source tree,
 369  *     you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
 370  *     <example id="gdbus-test-fixture">
 371  *       <title>Test Fixture for D-Bus services</title>
 372  *       <programlisting>
 373  *         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-test-fixture.c">
 374  *           <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
 375  *         </xi:include>
 376  *       </programlisting>
 377  *     </example>
 378  *   </para>
 379  *   <para>
 380  *     Note that these examples only deal with isolating the D-Bus aspect of your
 381  *     service. To successfully run isolated unit tests on your service you may need
 382  *     some additional modifications to your test case fixture. For example; if your
 383  *     service uses GSettings and installs a schema then it is important that your test service
 384  *     not load the schema in the ordinary installed location (chances are that your service
 385  *     and schema files are not yet installed, or worse; there is an older version of the
 386  *     schema file sitting in the install location).
 387  *   </para>
 388  *   <para>
 389  *     Most of the time we can work around these obstacles using the environment. Since the
 390  *     environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn
 391  *     inherited by any services the D-Bus daemon activates, using the setup routine for your
 392  *     fixture is a practical place to help sandbox your runtime environment. For the rather
 393  *     typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the
 394  *     in tree directory holding your schemas in the above fixture_setup() routine.
 395  *   </para>
 396  *   <para>
 397  *     The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
 398  *     by compiling the schemas locally as a step before running test cases, an autotools setup might
 399  *     do the following in the directory holding schemas:
 400  *     <informalexample><programlisting>
 401  *     all-am:
 402  *             $(GLIB_COMPILE_SCHEMAS) .
 403  *
 404  *     CLEANFILES += gschemas.compiled
 405  *     </programlisting></informalexample>
 406  *   </para>
 407  * </refsect2>
 408  */
 409
 410 typedef struct _GTestDBusClass   GTestDBusClass;
 411 typedef struct _GTestDBusPrivate GTestDBusPrivate;
 412
 413 /**
 414  * GTestDBus:
 415  *
 416  * The #GTestDBus structure contains only private data and
 417  * should only be accessed using the provided API.
 418  *
 419  * Since: 2.34
 420  */
 421 struct _GTestDBus {
 422   GObject parent;
 423
 424   GTestDBusPrivate *priv;
 425 };
 426
 427 struct _GTestDBusClass {
 428   GObjectClass parent_class;
 429 };
 430
 431 struct _GTestDBusPrivate
 432 {
 433   GTestDBusFlags flags;
 434   GPtrArray *service_dirs;
 435   GPid bus_pid;
 436   gchar *bus_address;
 437   gboolean up;
 438 };
 439
 440 enum
 441 {
 442   PROP_0,
 443   PROP_FLAGS,
 444 };
 445
 446 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
 447
 448 static void
 449 g_test_dbus_init (GTestDBus *self)
 450 {
 451   self->priv = g_test_dbus_get_instance_private (self);
 452   self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
 453 }
 454
 455 static void
 456 g_test_dbus_dispose (GObject *object)
 457 {
 458   GTestDBus *self = (GTestDBus *) object;
 459
 460   if (self->priv->up)
 461     g_test_dbus_down (self);
 462
 463   G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
 464 }
 465
 466 static void
 467 g_test_dbus_finalize (GObject *object)
 468 {
 469   GTestDBus *self = (GTestDBus *) object;
 470
 471   g_ptr_array_unref (self->priv->service_dirs);
 472   g_free (self->priv->bus_address);
 473
 474   G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
 475 }
 476
 477 static void
 478 g_test_dbus_get_property (GObject *object,
 479     guint property_id,
 480     GValue *value,
 481     GParamSpec *pspec)
 482 {
 483   GTestDBus *self = (GTestDBus *) object;
 484
 485   switch (property_id)
 486     {
 487       case PROP_FLAGS:
 488         g_value_set_flags (value, g_test_dbus_get_flags (self));
 489         break;
 490       default:
 491         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 492         break;
 493     }
 494 }
 495
 496 static void
 497 g_test_dbus_set_property (GObject *object,
 498     guint property_id,
 499     const GValue *value,
 500     GParamSpec *pspec)
 501 {
 502   GTestDBus *self = (GTestDBus *) object;
 503
 504   switch (property_id)
 505     {
 506       case PROP_FLAGS:
 507         self->priv->flags = g_value_get_flags (value);
 508         break;
 509       default:
 510         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 511         break;
 512     }
 513 }
 514
 515 static void
 516 g_test_dbus_class_init (GTestDBusClass *klass)
 517 {
 518   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 519
 520   object_class->dispose = g_test_dbus_dispose;
 521   object_class->finalize = g_test_dbus_finalize;
 522   object_class->get_property = g_test_dbus_get_property;
 523   object_class->set_property = g_test_dbus_set_property;
 524
 525   /**
 526    * GTestDBus:flags:
 527    *
 528    * #GTestDBusFlags specifying the behaviour of the D-Bus session.
 529    *
 530    * Since: 2.34
 531    */
 532   g_object_class_install_property (object_class, PROP_FLAGS,
 533     g_param_spec_flags ("flags",
 534                         P_("D-Bus session flags"),
 535                         P_("Flags specifying the behaviour of the D-Bus session"),
 536                         G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
 537                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 538                         G_PARAM_STATIC_STRINGS));
 539
 540 }
 541
 542 static gchar *
 543 write_config_file (GTestDBus *self)
 544 {
 545   GString *contents;
 546   gint fd;
 547   guint i;
 548   GError *error = NULL;
 549   gchar *path = NULL;
 550
 551   fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
 552   g_assert_no_error (error);
 553
 554   contents = g_string_new (NULL);
 555   g_string_append (contents,
 556       "<busconfig>\n"
 557       "  <type>session</type>\n"
 558 #ifdef G_OS_WIN32
 559       "  <listen>nonce-tcp:</listen>\n"
 560 #else
 561       "  <listen>unix:tmpdir=/tmp</listen>\n"
 562 #endif
 563                    );
 564
 565   for (i = 0; i < self->priv->service_dirs->len; i++)
 566     {
 567       const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
 568
 569       g_string_append_printf (contents,
 570           "  <servicedir>%s</servicedir>\n", dir_path);
 571     }
 572
 573   g_string_append (contents,
 574       "  <policy context=\"default\">\n"
 575       "    <!-- Allow everything to be sent -->\n"
 576       "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
 577       "    <!-- Allow everything to be received -->\n"
 578       "    <allow eavesdrop=\"true\"/>\n"
 579       "    <!-- Allow anyone to own anything -->\n"
 580       "    <allow own=\"*\"/>\n"
 581       "  </policy>\n"
 582       "</busconfig>\n");
 583
 584   g_file_set_contents (path, contents->str, contents->len, &error);
 585   g_assert_no_error (error);
 586
 587   g_string_free (contents, TRUE);
 588
 589   close (fd);
 590
 591   return path;
 592 }
 593
 594 static void
 595 start_daemon (GTestDBus *self)
 596 {
 597   const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
 598   gchar *config_path;
 599   gchar *config_arg;
 600   gint stdout_fd;
 601   GIOChannel *channel;
 602   gsize termpos;
 603   GError *error = NULL;
 604
 605   if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
 606     argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
 607
 608   /* Write config file and set its path in argv */
 609   config_path = write_config_file (self);
 610   config_arg = g_strdup_printf ("--config-file=%s", config_path);
 611   argv[2] = config_arg;
 612
 613   /* Spawn dbus-daemon */
 614   g_spawn_async_with_pipes (NULL,
 615                             (gchar **) argv,
 616                             NULL,
 617 #ifdef G_OS_WIN32
 618                             /* We Need this to get the pid returned on win32 */
 619                             G_SPAWN_DO_NOT_REAP_CHILD |
 620 #endif
 621                             G_SPAWN_SEARCH_PATH,
 622                             NULL,
 623                             NULL,
 624                             &self->priv->bus_pid,
 625                             NULL,
 626                             &stdout_fd,
 627                             NULL,
 628                             &error);
 629   g_assert_no_error (error);
 630
 631   _g_test_watcher_add_pid (self->priv->bus_pid);
 632
 633   /* Read bus address from daemon' stdout */
 634   channel = g_io_channel_unix_new (stdout_fd);
 635   g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
 636       &termpos, &error);
 637   g_assert_no_error (error);
 638   self->priv->bus_address[termpos] = '\0';
 639
 640   /* start dbus-monitor */
 641   if (g_getenv ("G_DBUS_MONITOR") != NULL)
 642     {
 643       gchar *command;
 644
 645       command = g_strdup_printf ("dbus-monitor --address %s",
 646           self->priv->bus_address);
 647       g_spawn_command_line_async (command, NULL);
 648       g_free (command);
 649
 650       g_usleep (500 * 1000);
 651     }
 652
 653   /* Cleanup */
 654   g_io_channel_shutdown (channel, FALSE, &error);
 655   g_assert_no_error (error);
 656   g_io_channel_unref (channel);
 657
 658   /* Don't use g_file_delete since it calls into gvfs */
 659   if (g_unlink (config_path) != 0)
 660     g_assert_not_reached ();
 661
 662   g_free (config_path);
 663   g_free (config_arg);
 664 }
 665
 666 static void
 667 stop_daemon (GTestDBus *self)
 668 {
 669 #ifdef G_OS_WIN32
 670   if (!TerminateProcess (self->priv->bus_pid, 0))
 671     g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
 672 #else
 673   kill (self->priv->bus_pid, SIGTERM);
 674 #endif
 675   _g_test_watcher_remove_pid (self->priv->bus_pid);
 676   g_spawn_close_pid (self->priv->bus_pid);
 677   self->priv->bus_pid = 0;
 678
 679   g_free (self->priv->bus_address);
 680   self->priv->bus_address = NULL;
 681 }
 682
 683 /**
 684  * g_test_dbus_new:
 685  * @flags: a #GTestDBusFlags
 686  *
 687  * Create a new #GTestDBus object.
 688  *
 689  * Returns: (transfer full): a new #GTestDBus.
 690  */
 691 GTestDBus *
 692 g_test_dbus_new (GTestDBusFlags flags)
 693 {
 694   return g_object_new (G_TYPE_TEST_DBUS,
 695       "flags", flags,
 696       NULL);
 697 }
 698
 699 /**
 700  * g_test_dbus_get_flags:
 701  * @self: a #GTestDBus
 702  *
 703  * Get the flags of the #GTestDBus object.
 704  *
 705  * Returns: the value of #GTestDBus:flags property
 706  */
 707 GTestDBusFlags
 708 g_test_dbus_get_flags (GTestDBus *self)
 709 {
 710   g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
 711
 712   return self->priv->flags;
 713 }
 714
 715 /**
 716  * g_test_dbus_get_bus_address:
 717  * @self: a #GTestDBus
 718  *
 719  * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
 720  * been called yet, %NULL is returned. This can be used with
 721  * g_dbus_connection_new_for_address().
 722  *
 723  * Returns: (allow-none): the address of the bus, or %NULL.
 724  */
 725 const gchar *
 726 g_test_dbus_get_bus_address (GTestDBus *self)
 727 {
 728   g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
 729
 730   return self->priv->bus_address;
 731 }
 732
 733 /**
 734  * g_test_dbus_add_service_dir:
 735  * @self: a #GTestDBus
 736  * @path: path to a directory containing .service files
 737  *
 738  * Add a path where dbus-daemon will look up .service files. This can't be
 739  * called after g_test_dbus_up().
 740  */
 741 void
 742 g_test_dbus_add_service_dir (GTestDBus *self,
 743     const gchar *path)
 744 {
 745   g_return_if_fail (G_IS_TEST_DBUS (self));
 746   g_return_if_fail (self->priv->bus_address == NULL);
 747
 748   g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
 749 }
 750
 751 /**
 752  * g_test_dbus_up:
 753  * @self: a #GTestDBus
 754  *
 755  * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
 756  * call, it is safe for unit tests to start sending messages on the session bus.
 757  *
 758  * If this function is called from setup callback of g_test_add(),
 759  * g_test_dbus_down() must be called in its teardown callback.
 760  *
 761  * If this function is called from unit test's main(), then g_test_dbus_down()
 762  * must be called after g_test_run().
 763  */
 764 void
 765 g_test_dbus_up (GTestDBus *self)
 766 {
 767   g_return_if_fail (G_IS_TEST_DBUS (self));
 768   g_return_if_fail (self->priv->bus_address == NULL);
 769   g_return_if_fail (!self->priv->up);
 770
 771   start_daemon (self);
 772
 773   g_test_dbus_unset ();
 774   g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
 775   self->priv->up = TRUE;
 776 }
 777
 778
 779 /**
 780  * g_test_dbus_stop:
 781  * @self: a #GTestDBus
 782  *
 783  * Stop the session bus started by g_test_dbus_up().
 784  *
 785  * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 786  * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 787  * tests wanting to verify behaviour after the session bus has been stopped
 788  * can use this function but should still call g_test_dbus_down() when done.
 789  */
 790 void
 791 g_test_dbus_stop (GTestDBus *self)
 792 {
 793   g_return_if_fail (G_IS_TEST_DBUS (self));
 794   g_return_if_fail (self->priv->bus_address != NULL);
 795
 796   stop_daemon (self);
 797 }
 798
 799 /**
 800  * g_test_dbus_down:
 801  * @self: a #GTestDBus
 802  *
 803  * Stop the session bus started by g_test_dbus_up().
 804  *
 805  * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 806  * is destroyed. This is done to ensure that the next unit test won't get a
 807  * leaked singleton from this test.
 808  */
 809 void
 810 g_test_dbus_down (GTestDBus *self)
 811 {
 812   GDBusConnection *connection;
 813
 814   g_return_if_fail (G_IS_TEST_DBUS (self));
 815   g_return_if_fail (self->priv->up);
 816
 817   connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
 818   if (connection != NULL)
 819     g_dbus_connection_set_exit_on_close (connection, FALSE);
 820
 821   if (self->priv->bus_address != NULL)
 822     stop_daemon (self);
 823
 824   if (connection != NULL)
 825     _g_object_dispose_and_wait_weak_notify (connection);
 826
 827   g_test_dbus_unset ();
 828   self->priv->up = FALSE;
 829 }
 830
 831 /**
 832  * g_test_dbus_unset:
 833  *
 834  * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 835  * won't use user's session bus.
 836  *
 837  * This is useful for unit tests that want to verify behaviour when no session
 838  * bus is running. It is not necessary to call this if unit test already calls
 839  * g_test_dbus_up() before acquiring the session bus.
 840  */
 841 void
 842 g_test_dbus_unset (void)
 843 {
 844   g_unsetenv ("DISPLAY");
 845   g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
 846   g_unsetenv ("DBUS_STARTER_ADDRESS");
 847   g_unsetenv ("DBUS_STARTER_BUS_TYPE");
 848 }